Changes in safe.c

1e17c117 - safe(4): Remove a double word in a source code comment

Sat, 20 Apr 2024 12:12:23 +0000

safe(4): Remove a double word in a source code comment- s/of of/of/(cherry picked from commit 1bbdcf62d3ac8fbea2d4c5b37ccd9ac2032d37d7) List of files: /freebsd-14.2/sys/dev/safe/safe.c

685dc743 - sys: Remove $FreeBSD$: one-line .c pattern

Wed, 16 Aug 2023 17:54:36 +0000

sys: Remove $FreeBSD$: one-line .c patternRemove /^[\s*]*__FBSDID$"\$FreeBSD\$"$;?\s*\n/ List of files: /freebsd-14.2/sys/dev/safe/safe.c

4d846d26 - spdx: The BSD-2-Clause-FreeBSD identifier is obsolete, drop -FreeBSD

Wed, 10 May 2023 15:40:58 +0000

spdx: The BSD-2-Clause-FreeBSD identifier is obsolete, drop -FreeBSDThe SPDX folks have obsoleted the BSD-2-Clause-FreeBSD identifier. Catchup to that fact and revert to their recommended match of BSD-2-Clause.Discussed with: pfgMFC After: 3 daysSponsored by: Netflix List of files: /freebsd-14.2/sys/dev/safe/safe.c

a15fbf0c - safe: Remove unused devclass argument to DRIVER_MODULE.

Mon, 09 May 2022 19:22:04 +0000

safe: Remove unused devclass argument to DRIVER_MODULE. List of files: /freebsd-14.2/sys/dev/safe/safe.c

81d4309f - safe(4): Fix a typo in a source code comment

Sat, 02 Apr 2022 12:03:17 +0000

safe(4): Fix a typo in a source code comment- s/multple/multiple/MFC after: 3 days List of files: /freebsd-14.2/sys/dev/safe/safe.c

76681661 - OCF: Remove support for asymmetric cryptographic operations.

Mon, 12 Apr 2021 21:27:42 +0000

OCF: Remove support for asymmetric cryptographic operations.There haven't been any non-obscure drivers that supported thisfunctionality and it has been impossible to test to ensure that itstill works. The only known consumer of this interface was the enginein OpenSSL < 1.1. Modern OpenSSL versions do not include support forthis interface as it was not well-documented.Reviewed by: cemSponsored by: Chelsio CommunicationsDifferential Revision: https://reviews.freebsd.org/D29736 List of files: /freebsd-14.2/sys/dev/safe/safe.c

895c98cc - Don't return errors from the cryptodev_process() method.

Tue, 08 Sep 2020 22:41:35 +0000

Don't return errors from the cryptodev_process() method.The cryptodev_process() method should either return 0 if it hascompleted a request, or ERESTART to defer the request until later. Ifa request encounters an error, the error should be reported viacrp_etype before completing the request via crypto_done().Fix a few more drivers noticed by asomers@ similar to the fix inr365389. This is an old bug, but went unnoticed since crypto requestsdid not start failing as a normal part of operation until digestverification was introduced which can fail requests with EBADMSG.PR: 247986Reported by: asomersSponsored by: Chelsio CommunicationsDifferential Revision: https://reviews.freebsd.org/D26361 List of files: /freebsd-14.2/sys/dev/safe/safe.c

6a8b28c6 - safe: clean up empty lines in .c and .h files

Tue, 01 Sep 2020 21:55:23 +0000

safe: clean up empty lines in .c and .h files List of files: /freebsd-14.2/sys/dev/safe/safe.c

9c0e3d3a - Add support for optional separate output buffers to in-kernel crypto.

Mon, 25 May 2020 22:12:04 +0000

Add support for optional separate output buffers to in-kernel crypto.Some crypto consumers such as GELI and KTLS for file-backed sendfileneed to store their output in a separate buffer from the input.Currently these consumers copy the contents of the input buffer intothe output buffer and queue an in-place crypto operation on the outputbuffer. Using a separate output buffer avoids this copy.- Create a new 'struct crypto_buffer' describing a crypto buffer containing a type and type-specific fields. crp_ilen is gone, instead buffers that use a flat kernel buffer have a cb_buf_len field for their length. The length of other buffer types is inferred from the backing store (e.g. uio_resid for a uio). Requests now have two such structures: crp_buf for the input buffer, and crp_obuf for the output buffer.- Consumers now use helper functions (crypto_use_*, e.g. crypto_use_mbuf()) to configure the input buffer. If an output buffer is not configured, the request still modifies the input buffer in-place. A consumer uses a second set of helper functions (crypto_use_output_*) to configure an output buffer.- Consumers must request support for separate output buffers when creating a crypto session via the CSP_F_SEPARATE_OUTPUT flag and are only permitted to queue a request with a separate output buffer on sessions with this flag set. Existing drivers already reject sessions with unknown flags, so this permits drivers to be modified to support this extension without requiring all drivers to change.- Several data-related functions now have matching versions that operate on an explicit buffer (e.g. crypto_apply_buf, crypto_contiguous_subsegment_buf, bus_dma_load_crp_buf).- Most of the existing data-related functions operate on the input buffer. However crypto_copyback always writes to the output buffer if a request uses a separate output buffer.- For the regions in input/output buffers, the following conventions are followed: - AAD and IV are always present in input only and their fields are offsets into the input buffer. - payload is always present in both buffers. If a request uses a separate output buffer, it must set a new crp_payload_start_output field to the offset of the payload in the output buffer. - digest is in the input buffer for verify operations, and in the output buffer for compute operations. crp_digest_start is relative to the appropriate buffer.- Add a crypto buffer cursor abstraction. This is a more general form of some bits in the cryptosoft driver that tried to always use uio's. However, compared to the original code, this avoids rewalking the uio iovec array for requests with multiple vectors. It also avoids allocate an iovec array for mbufs and populating it by instead walking the mbuf chain directly.- Update the cryptosoft(4) driver to support separate output buffers making use of the cursor abstraction.Sponsored by: NetflixDifferential Revision: https://reviews.freebsd.org/D24545 List of files: /freebsd-14.2/sys/dev/safe/safe.c

63823cac - Remove MD5 HMAC from OCF.

Mon, 11 May 2020 22:08:08 +0000

Remove MD5 HMAC from OCF.There are no in-kernel consumers.Reviewed by: cemRelnotes: yesSponsored by: Chelsio CommunicationsDifferential Revision: https://reviews.freebsd.org/D24775 List of files: /freebsd-14.2/sys/dev/safe/safe.c

0e00c709 - Remove support for DES and Triple DES from OCF.

Mon, 11 May 2020 21:34:29 +0000

Remove support for DES and Triple DES from OCF.It no longer has any in-kernel consumers via OCF. smbfs still usessingle DES directly, so sys/crypto/des remains for that use case.Reviewed by: cemRelnotes: yesSponsored by: Chelsio CommunicationsDifferential Revision: https://reviews.freebsd.org/D24773 List of files: /freebsd-14.2/sys/dev/safe/safe.c

29fe41dd - Retire the CRYPTO_F_IV_GENERATE flag.

Mon, 20 Apr 2020 22:24:49 +0000

Retire the CRYPTO_F_IV_GENERATE flag.The sole in-tree user of this flag has been retired, so remove thiscomplexity from all drivers. While here, add a helper routine driverscan use to read the current request's IV into a local buffer. Usethis routine to replace duplicated code in nearly all drivers.Reviewed by: cemSponsored by: NetflixDifferential Revision: https://reviews.freebsd.org/D24450 List of files: /freebsd-14.2/sys/dev/safe/safe.c

c0341432 - Refactor driver and consumer interfaces for OCF (in-kernel crypto).

Fri, 27 Mar 2020 18:25:23 +0000

Refactor driver and consumer interfaces for OCF (in-kernel crypto).- The linked list of cryptoini structures used in session initialization is replaced with a new flat structure: struct crypto_session_params. This session includes a new mode to define how the other fields should be interpreted. Available modes include: - COMPRESS (for compression/decompression) - CIPHER (for simply encryption/decryption) - DIGEST (computing and verifying digests) - AEAD (combined auth and encryption such as AES-GCM and AES-CCM) - ETA (combined auth and encryption using encrypt-then-authenticate) Additional modes could be added in the future (e.g. if we wanted to support TLS MtE for AES-CBC in the kernel we could add a new mode for that. TLS modes might also affect how AAD is interpreted, etc.) The flat structure also includes the key lengths and algorithms as before. However, code doesn't have to walk the linked list and switch on the algorithm to determine which key is the auth key vs encryption key. The 'csp_auth_*' fields are always used for auth keys and settings and 'csp_cipher_*' for cipher. (Compression algorithms are stored in csp_cipher_alg.)- Drivers no longer register a list of supported algorithms. This doesn't quite work when you factor in modes (e.g. a driver might support both AES-CBC and SHA2-256-HMAC separately but not combined for ETA). Instead, a new 'crypto_probesession' method has been added to the kobj interface for symmteric crypto drivers. This method returns a negative value on success (similar to how device_probe works) and the crypto framework uses this value to pick the "best" driver. There are three constants for hardware (e.g. ccr), accelerated software (e.g. aesni), and plain software (cryptosoft) that give preference in that order. One effect of this is that if you request only hardware when creating a new session, you will no longer get a session using accelerated software. Another effect is that the default setting to disallow software crypto via /dev/crypto now disables accelerated software. Once a driver is chosen, 'crypto_newsession' is invoked as before.- Crypto operations are now solely described by the flat 'cryptop' structure. The linked list of descriptors has been removed. A separate enum has been added to describe the type of data buffer in use instead of using CRYPTO_F_* flags to make it easier to add more types in the future if needed (e.g. wired userspace buffers for zero-copy). It will also make it easier to re-introduce separate input and output buffers (in-kernel TLS would benefit from this). Try to make the flags related to IV handling less insane: - CRYPTO_F_IV_SEPARATE means that the IV is stored in the 'crp_iv' member of the operation structure. If this flag is not set, the IV is stored in the data buffer at the 'crp_iv_start' offset. - CRYPTO_F_IV_GENERATE means that a random IV should be generated and stored into the data buffer. This cannot be used with CRYPTO_F_IV_SEPARATE. If a consumer wants to deal with explicit vs implicit IVs, etc. it can always generate the IV however it needs and store partial IVs in the buffer and the full IV/nonce in crp_iv and set CRYPTO_F_IV_SEPARATE. The layout of the buffer is now described via fields in cryptop. crp_aad_start and crp_aad_length define the boundaries of any AAD. Previously with GCM and CCM you defined an auth crd with this range, but for ETA your auth crd had to span both the AAD and plaintext (and they had to be adjacent). crp_payload_start and crp_payload_length define the boundaries of the plaintext/ciphertext. Modes that only do a single operation (COMPRESS, CIPHER, DIGEST) should only use this region and leave the AAD region empty. If a digest is present (or should be generated), it's starting location is marked by crp_digest_start. Instead of using the CRD_F_ENCRYPT flag to determine the direction of the operation, cryptop now includes an 'op' field defining the operation to perform. For digests I've added a new VERIFY digest mode which assumes a digest is present in the input and fails the request with EBADMSG if it doesn't match the internally-computed digest. GCM and CCM already assumed this, and the new AEAD mode requires this for decryption. The new ETA mode now also requires this for decryption, so IPsec and GELI no longer do their own authentication verification. Simple DIGEST operations can also do this, though there are no in-tree consumers. To eventually support some refcounting to close races, the session cookie is now passed to crypto_getop() and clients should no longer set crp_sesssion directly.- Assymteric crypto operation structures should be allocated via crypto_getkreq() and freed via crypto_freekreq(). This permits the crypto layer to track open asym requests and close races with a driver trying to unregister while asym requests are in flight.- crypto_copyback, crypto_copydata, crypto_apply, and crypto_contiguous_subsegment now accept the 'crp' object as the first parameter instead of individual members. This makes it easier to deal with different buffer types in the future as well as separate input and output buffers. It's also simpler for driver writers to use.- bus_dmamap_load_crp() loads a DMA mapping for a crypto buffer. This understands the various types of buffers so that drivers that use DMA do not have to be aware of different buffer types.- Helper routines now exist to build an auth context for HMAC IPAD and OPAD. This reduces some duplicated work among drivers.- Key buffers are now treated as const throughout the framework and in device drivers. However, session key buffers provided when a session is created are expected to remain alive for the duration of the session.- GCM and CCM sessions now only specify a cipher algorithm and a cipher key. The redundant auth information is not needed or used.- For cryptosoft, split up the code a bit such that the 'process' callback now invokes a function pointer in the session. This function pointer is set based on the mode (in effect) though it simplifies a few edge cases that would otherwise be in the switch in 'process'. It does split up GCM vs CCM which I think is more readable even if there is some duplication.- I changed /dev/crypto to support GMAC requests using CRYPTO_AES_NIST_GMAC as an auth algorithm and updated cryptocheck to work with it.- Combined cipher and auth sessions via /dev/crypto now always use ETA mode. The COP_F_CIPHER_FIRST flag is now a no-op that is ignored. This was actually documented as being true in crypto(4) before, but the code had not implemented this before I added the CIPHER_FIRST flag.- I have not yet updated /dev/crypto to be aware of explicit modes for sessions. I will probably do that at some point in the future as well as teach it about IV/nonce and tag lengths for AEAD so we can support all of the NIST KAT tests for GCM and CCM.- I've split up the exising crypto.9 manpage into several pages of which many are written from scratch.- I have converted all drivers and consumers in the tree and verified that they compile, but I have not tested all of them. I have tested the following drivers: - cryptosoft - aesni (AES only) - blake2 - ccr and the following consumers: - cryptodev - IPsec - ktls_ocf - GELI (lightly) I have not tested the following: - ccp - aesni with sha - hifn - kgssapi_krb5 - ubsec - padlock - safe - armv8_crypto (aarch64) - glxsb (i386) - sec (ppc) - cesa (armv7) - cryptocteon (mips64) - nlmsec (mips64)Discussed with: cemRelnotes: yesSponsored by: Chelsio CommunicationsDifferential Revision: https://reviews.freebsd.org/D23677 List of files: /freebsd-14.2/sys/dev/safe/safe.c

7029da5c - Mark more nodes as CTLFLAG_MPSAFE or CTLFLAG_NEEDGIANT (17 of many)

Wed, 26 Feb 2020 14:26:36 +0000

Mark more nodes as CTLFLAG_MPSAFE or CTLFLAG_NEEDGIANT (17 of many)r357614 added CTLFLAG_NEEDGIANT to make it easier to find nodes that arestill not MPSAFE (or already are but aren’t properly marked).Use it in preparation for a general review of all nodes.This is non-functional change that adds annotations to SYSCTL_NODE andSYSCTL_PROC nodes using one of the soon-to-be-required flags.Mark all obvious cases as MPSAFE. All entries that haven't been markedas MPSAFE before are by default marked as NEEDGIANTApproved by: kib (mentor, blanket)Commented by: kib, gallatin, melifaroDifferential Revision: https://reviews.freebsd.org/D23718 List of files: /freebsd-14.2/sys/dev/safe/safe.c

19fa89e9 - Remove the Yarrow PRNG algorithm option in accordance with due notice

Sun, 26 Aug 2018 12:51:46 +0000

Remove the Yarrow PRNG algorithm option in accordance with due noticegiven in random(4).This includes updating of the relevant man pages, and no-longer-usedharvesting parameters.Ensure that the pseudo-unit-test still does something useful, now alsowith the "other" algorithm instead of Yarrow.PR: 230870Reviewed by: cemApproved by: so(delphij,gtetlow)Approved by: re(marius)Differential Revision: https://reviews.freebsd.org/D16898 List of files: /freebsd-14.2/sys/dev/safe/safe.c

1b0909d5 - OpenCrypto: Convert sessions to opaque handles instead of integers

Wed, 18 Jul 2018 00:56:25 +0000

OpenCrypto: Convert sessions to opaque handles instead of integersTrack session objects in the framework, and pass handles between theframework (OCF), consumers, and drivers. Avoid redundancy and complexity inindividual drivers by allocating session memory in the framework andproviding it to drivers in ::newsession().Session handles are no longer integers with information encoded in varioushigh bits. Use of the CRYPTO_SESID2FOO() macros should be replaced with theappropriate crypto_ses2foo() function on the opaque session handle.Convert OCF drivers (in particular, cryptosoft, as well as myriad others) tothe opaque handle interface. Discard existing session tracking as much aspossible (quick pass). There may be additional code ripe for deletion.Convert OCF consumers (ipsec, geom_eli, krb5, cryptodev) to handle-styleinterface. The conversion is largely mechnical.The change is documented in crypto.9.Inspired byhttps://lists.freebsd.org/pipermail/freebsd-arch/2018-January/018835.html .No objection from: ae (ipsec portion)Reported by: jhb List of files: /freebsd-14.2/sys/dev/safe/safe.c

590adc1b - Remove "HMAC" from _HMAC_BLOCK_LEN macro names

Mon, 09 Jul 2018 07:21:37 +0000

Remove "HMAC" from _HMAC_BLOCK_LEN macro namesThe block size is a property of the underlying hash algorithm, and hasnothing to do with the HMAC construction.No functional change. List of files: /freebsd-14.2/sys/dev/safe/safe.c

718cf2cc - sys/dev: further adoption of SPDX licensing ID tags.

Mon, 27 Nov 2017 14:52:40 +0000

sys/dev: further adoption of SPDX licensing ID tags.Mainly focus on files that use BSD 2-Clause license, however the tool Iwas using misidentified many licenses so this was mostly a manual - errorprone - task.The Software Package Data Exchange (SPDX) group provides a specificationto make it easier for automated tools to detect and summarize well knownopensource licenses. We are gradually adopting the specification, notingthat the tags are considered only advisory and do not, in any way,superceed or replace the license texts. List of files: /freebsd-14.2/sys/dev/safe/safe.c

19a9c3df - safe: quiet -Wtautological-compare

Fri, 18 Aug 2017 08:05:33 +0000

safe: quiet -Wtautological-compareCode was testing that an unsigned type was >= 0.Reviewed by: markjApproved by: markj (mentor)Sponsored by: Dell EMC Isilon List of files: /freebsd-14.2/sys/dev/safe/safe.c

d1b06863 - Huge cleanup of random(4) code.

Tue, 30 Jun 2015 17:00:45 +0000

Huge cleanup of random(4) code.* GENERAL- Update copyright.- Make kernel options for RANDOM_YARROW and RANDOM_DUMMY. Set neither to ON, which means we want Fortuna- If there is no 'device random' in the kernel, there will be NO random(4) device in the kernel, and the KERN_ARND sysctl will return nothing. With RANDOM_DUMMY there will be a random(4) that always blocks.- Repair kern.arandom (KERN_ARND sysctl). The old version went through arc4random(9) and was a bit weird.- Adjust arc4random stirring a bit - the existing code looks a little suspect.- Fix the nasty pre- and post-read overloading by providing explictit functions to do these tasks.- Redo read_random(9) so as to duplicate random(4)'s read internals. This makes it a first-class citizen rather than a hack.- Move stuff out of locked regions when it does not need to be there.- Trim RANDOM_DEBUG printfs. Some are excess to requirement, some behind boot verbose.- Use SYSINIT to sequence the startup.- Fix init/deinit sysctl stuff.- Make relevant sysctls also tunables.- Add different harvesting "styles" to allow for different requirements (direct, queue, fast).- Add harvesting of FFS atime events. This needs to be checked for weighing down the FS code.- Add harvesting of slab allocator events. This needs to be checked for weighing down the allocator code.- Fix the random(9) manpage.- Loadable modules are not present for now. These will be re-engineered when the dust settles.- Use macros for locks.- Fix comments.* src/share/man/...- Update the man pages.* src/etc/...- The startup/shutdown work is done in D2924.* src/UPDATING- Add UPDATING announcement.* src/sys/dev/random/build.sh- Add copyright.- Add libz for unit tests.* src/sys/dev/random/dummy.c- Remove; no longer needed. Functionality incorporated into randomdev.*.* live_entropy_sources.c live_entropy_sources.h- Remove; content moved.- move content to randomdev.[ch] and optimise.* src/sys/dev/random/random_adaptors.c src/sys/dev/random/random_adaptors.h- Remove; plugability is no longer used. Compile-time algorithm selection is the way to go.* src/sys/dev/random/random_harvestq.c src/sys/dev/random/random_harvestq.h- Add early (re)boot-time randomness caching.* src/sys/dev/random/randomdev_soft.c src/sys/dev/random/randomdev_soft.h- Remove; no longer needed.* src/sys/dev/random/uint128.h- Provide a fake uint128_t; if a real one ever arrived, we can use that instead. All that is needed here is N=0, N++, N==0, and some localised trickery is used to manufacture a 128-bit 0ULLL.* src/sys/dev/random/unit_test.c src/sys/dev/random/unit_test.h- Improve unit tests; previously the testing human needed clairvoyance; now the test will do a basic check of compressibility. Clairvoyant talent is still a good idea.- This is still a long way off a proper unit test.* src/sys/dev/random/fortuna.c src/sys/dev/random/fortuna.h- Improve messy union to just uint128_t.- Remove unneeded 'static struct fortuna_start_cache'.- Tighten up up arithmetic.- Provide a method to allow eternal junk to be introduced; harden it against blatant by compress/hashing.- Assert that locks are held correctly.- Fix the nasty pre- and post-read overloading by providing explictit functions to do these tasks.- Turn into self-sufficient module (no longer requires randomdev_soft.[ch])* src/sys/dev/random/yarrow.c src/sys/dev/random/yarrow.h- Improve messy union to just uint128_t.- Remove unneeded 'staic struct start_cache'.- Tighten up up arithmetic.- Provide a method to allow eternal junk to be introduced; harden it against blatant by compress/hashing.- Assert that locks are held correctly.- Fix the nasty pre- and post-read overloading by providing explictit functions to do these tasks.- Turn into self-sufficient module (no longer requires randomdev_soft.[ch])- Fix some magic numbers elsewhere used as FAST and SLOW.Differential Revision: https://reviews.freebsd.org/D2025Reviewed by: vsevolod,delphij,rwatson,trasz,jmgApproved by: so (delphij) List of files: /freebsd-14.2/sys/dev/safe/safe.c