crypto package - crypto

Documentation ¶

Package crypto collects common cryptographic constants.

This section is empty.

RegisterHash registers a function that returns a new instance of the given hash function. This is intended to be called from the init function in packages that implement hash functions.

SignMessage signs msg with signer. If signer implements MessageSigner, [MessageSigner.SignMessage] is called directly. Otherwise, msg is hashed with opts.HashFunc() and signed with [Signer.Sign].

type Decapsulator interface {
	Encapsulator() Encapsulator
	Decapsulate(ciphertext []byte) (sharedKey []byte, err error)
}

Decapsulator is an interface for an opaque private KEM key that can be used for decapsulation operations. For example, an ML-KEM key kept in a hardware module.

It is implemented, for example, by crypto/mlkem.DecapsulationKey768.

Decrypter is an interface for an opaque private key that can be used for asymmetric decryption operations. An example would be an RSA key kept in a hardware module.

type Encapsulator interface {
	Bytes() []byte
	Encapsulate() (sharedKey, ciphertext []byte)
}

Encapsulator is an interface for a public KEM key that can be used for encapsulation operations.

It is implemented, for example, by crypto/mlkem.EncapsulationKey768.

Hash identifies a cryptographic hash function that is implemented in another package.

const (
	MD4         Hash = 1 + iota 
	MD5                         
	SHA1                        
	SHA224                      
	SHA256                      
	SHA384                      
	SHA512                      
	MD5SHA1                     
	RIPEMD160                   
	SHA3_224                    
	SHA3_256                    
	SHA3_384                    
	SHA3_512                    
	SHA512_224                  
	SHA512_256                  
	BLAKE2s_256                 
	BLAKE2b_256                 
	BLAKE2b_384                 
	BLAKE2b_512                 

)

func (h Hash) Available() bool

Available reports whether the given hash function is linked into the binary.

func (h Hash) HashFunc() Hash

HashFunc simply returns the value of h so that Hash implements SignerOpts.

New returns a new hash.Hash calculating the given hash function. New panics if the hash function is not linked into the binary.

Size returns the length, in bytes, of a digest resulting from the given hash function. It doesn't require that the hash function in question be linked into the program.

MessageSigner is an interface for an opaque private key that can be used for signing operations where the message is not pre-hashed by the caller. It is a superset of the Signer interface so that it can be passed to APIs which accept Signer, which may try to do an interface upgrade.

MessageSigner.SignMessage and MessageSigner.Sign should produce the same result given the same opts. In particular, MessageSigner.SignMessage should only accept a zero opts.HashFunc if the Signer would also accept messages which are not pre-hashed.

Implementations which do not provide the pre-hashed Sign API should implement Signer.Sign by always returning an error.

PrivateKey represents a private key using an unspecified algorithm.

Although this type is an empty interface for backwards compatibility reasons, all private key types in the standard library implement the following interface

interface{
    Public() crypto.PublicKey
    Equal(x crypto.PrivateKey) bool
}

as well as purpose-specific interfaces such as Signer and Decrypter, which can be used for increased type safety within applications.

PublicKey represents a public key using an unspecified algorithm.

Although this type is an empty interface for backwards compatibility reasons, all public key types in the standard library implement the following interface

interface{
    Equal(x crypto.PublicKey) bool
}

which can be used for increased type safety within applications.

Signer is an interface for an opaque private key that can be used for signing operations. For example, an RSA key kept in a hardware module.

type SignerOpts interface {
	
	
	
	HashFunc() Hash
}

SignerOpts contains options for signing with a Signer.

Directories ¶

Path	Synopsis
aes Package aes implements AES encryption (formerly Rijndael), as defined in U.S. Federal Information Processing Standards Publication 197.	Package aes implements AES encryption (formerly Rijndael), as defined in U.S. Federal Information Processing Standards Publication 197.
cipher Package cipher implements standard block cipher modes that can be wrapped around low-level block cipher implementations.	Package cipher implements standard block cipher modes that can be wrapped around low-level block cipher implementations.
des Package des implements the Data Encryption Standard (DES) and the Triple Data Encryption Algorithm (TDEA) as defined in U.S. Federal Information Processing Standards Publication 46-3.	Package des implements the Data Encryption Standard (DES) and the Triple Data Encryption Algorithm (TDEA) as defined in U.S. Federal Information Processing Standards Publication 46-3.
dsa Package dsa implements the Digital Signature Algorithm, as defined in FIPS 186-3.	Package dsa implements the Digital Signature Algorithm, as defined in FIPS 186-3.
ecdh Package ecdh implements Elliptic Curve Diffie-Hellman over NIST curves and Curve25519.	Package ecdh implements Elliptic Curve Diffie-Hellman over NIST curves and Curve25519.
ecdsa Package ecdsa implements the Elliptic Curve Digital Signature Algorithm, as defined in [FIPS 186-5].	Package ecdsa implements the Elliptic Curve Digital Signature Algorithm, as defined in [FIPS 186-5].
ed25519 Package ed25519 implements the Ed25519 signature algorithm.	Package ed25519 implements the Ed25519 signature algorithm.
elliptic Package elliptic implements the standard NIST P-224, P-256, P-384, and P-521 elliptic curves over prime fields.	Package elliptic implements the standard NIST P-224, P-256, P-384, and P-521 elliptic curves over prime fields.
fips140
hkdf Package hkdf implements the HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869.	Package hkdf implements the HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869.
hmac Package hmac implements the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198.	Package hmac implements the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198.
hpke Package hpke implements Hybrid Public Key Encryption (HPKE) as defined in [RFC 9180].	Package hpke implements Hybrid Public Key Encryption (HPKE) as defined in [RFC 9180].
internal
boring Package boring provides access to BoringCrypto implementation functions.	Package boring provides access to BoringCrypto implementation functions.
boring/bbig
boring/bcache Package bcache implements a GC-friendly cache (see Cache) for BoringCrypto.	Package bcache implements a GC-friendly cache (see Cache) for BoringCrypto.
boring/sig Package sig holds “code signatures” that can be called and will result in certain code sequences being linked into the final binary.	Package sig holds “code signatures” that can be called and will result in certain code sequences being linked into the final binary.
constanttime
cryptotest
entropy Package entropy provides the passive entropy source for the FIPS 140-3 module.	Package entropy provides the passive entropy source for the FIPS 140-3 module.
entropy/v1.0.0 Package entropy implements a CPU jitter-based SP 800-90B entropy source.	Package entropy implements a CPU jitter-based SP 800-90B entropy source.
fips140
fips140/aes
fips140/aes/gcm
fips140/alias Package alias implements memory aliasing tests.	Package alias implements memory aliasing tests.
fips140/bigmod
fips140/check Package check implements the FIPS 140 load-time code+data verification.	Package check implements the FIPS 140 load-time code+data verification.
fips140/check/checktest Package checktest defines some code and data for use in the crypto/internal/fips140/check test.	Package checktest defines some code and data for use in the crypto/internal/fips140/check test.
fips140/drbg Package drbg provides cryptographically secure random bytes usable by FIPS code.	Package drbg provides cryptographically secure random bytes usable by FIPS code.
fips140/ecdh
fips140/ecdsa
fips140/ed25519
fips140/edwards25519 Package edwards25519 implements group logic for the twisted Edwards curve	Package edwards25519 implements group logic for the twisted Edwards curve
fips140/edwards25519/field Package field implements fast arithmetic modulo 2^255-19.	Package field implements fast arithmetic modulo 2^255-19.
fips140/hkdf
fips140/hmac Package hmac implements HMAC according to [FIPS 198-1].	Package hmac implements HMAC according to [FIPS 198-1].
fips140/mldsa
fips140/mlkem Package mlkem implements the quantum-resistant key encapsulation method ML-KEM (formerly known as Kyber), as specified in [NIST FIPS 203].	Package mlkem implements the quantum-resistant key encapsulation method ML-KEM (formerly known as Kyber), as specified in [NIST FIPS 203].
fips140/nistec Package nistec implements the elliptic curves from NIST SP 800-186.	Package nistec implements the elliptic curves from NIST SP 800-186.
fips140/nistec/fiat
fips140/pbkdf2
fips140/rsa
fips140/sha256 Package sha256 implements the SHA-224 and SHA-256 hash algorithms as defined in FIPS 180-4.	Package sha256 implements the SHA-224 and SHA-256 hash algorithms as defined in FIPS 180-4.
fips140/sha3 Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length functions defined by [FIPS 202], as well as the cSHAKE extendable-output-length functions defined by [SP 800-185].	Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length functions defined by [FIPS 202], as well as the cSHAKE extendable-output-length functions defined by [SP 800-185].
fips140/sha512 Package sha512 implements the SHA-384, SHA-512, SHA-512/224, and SHA-512/256 hash algorithms as defined in FIPS 180-4.	Package sha512 implements the SHA-384, SHA-512, SHA-512/224, and SHA-512/256 hash algorithms as defined in FIPS 180-4.
fips140/ssh Package ssh implements the SSH KDF as specified in RFC 4253, Section 7.2 and allowed by SP 800-135 Revision 1.	Package ssh implements the SSH KDF as specified in RFC 4253, Section 7.2 and allowed by SP 800-135 Revision 1.
fips140/subtle
fips140/tls12
fips140/tls13 Package tls13 implements the TLS 1.3 Key Schedule as specified in RFC 8446, Section 7.1 and allowed by FIPS 140-3 IG 2.4.B Resolution 7.	Package tls13 implements the TLS 1.3 Key Schedule as specified in RFC 8446, Section 7.1 and allowed by FIPS 140-3 IG 2.4.B Resolution 7.
fips140cache Package fips140cache provides a weak map that associates the lifetime of values with the lifetime of keys.	Package fips140cache provides a weak map that associates the lifetime of values with the lifetime of keys.
fips140deps Package fipsdeps contains wrapper packages for internal APIs that are exposed to the FIPS module.	Package fipsdeps contains wrapper packages for internal APIs that are exposed to the FIPS module.
fips140deps/byteorder
fips140deps/cpu
fips140deps/godebug
fips140deps/time
fips140hash
fips140only
impl Package impl is a registry of alternative implementations of cryptographic primitives, to allow selecting them for testing.	Package impl is a registry of alternative implementations of cryptographic primitives, to allow selecting them for testing.
rand
randutil Package randutil contains internal randomness utilities for various crypto packages.	Package randutil contains internal randomness utilities for various crypto packages.
sysrand Package rand provides cryptographically secure random bytes from the operating system.	Package rand provides cryptographically secure random bytes from the operating system.
sysrand/internal/seccomp
md5 Package md5 implements the MD5 hash algorithm as defined in RFC 1321.	Package md5 implements the MD5 hash algorithm as defined in RFC 1321.
mlkem Package mlkem implements the quantum-resistant key encapsulation method ML-KEM (formerly known as Kyber), as specified in [NIST FIPS 203].	Package mlkem implements the quantum-resistant key encapsulation method ML-KEM (formerly known as Kyber), as specified in [NIST FIPS 203].
mlkemtest Package mlkemtest provides testing functions for the ML-KEM algorithm.	Package mlkemtest provides testing functions for the ML-KEM algorithm.
pbkdf2 Package pbkdf2 implements the key derivation function PBKDF2 as defined in RFC 8018 (PKCS #5 v2.1).	Package pbkdf2 implements the key derivation function PBKDF2 as defined in RFC 8018 (PKCS #5 v2.1).
rand Package rand implements a cryptographically secure random number generator.	Package rand implements a cryptographically secure random number generator.
rc4 Package rc4 implements RC4 encryption, as defined in Bruce Schneier's Applied Cryptography.	Package rc4 implements RC4 encryption, as defined in Bruce Schneier's Applied Cryptography.
rsa Package rsa implements RSA encryption as specified in PKCS #1 and RFC 8017.	Package rsa implements RSA encryption as specified in PKCS #1 and RFC 8017.
sha1 Package sha1 implements the SHA-1 hash algorithm as defined in RFC 3174.	Package sha1 implements the SHA-1 hash algorithm as defined in RFC 3174.
sha256 Package sha256 implements the SHA224 and SHA256 hash algorithms as defined in FIPS 180-4.	Package sha256 implements the SHA224 and SHA256 hash algorithms as defined in FIPS 180-4.
sha3 Package sha3 implements the SHA-3 hash algorithms and the SHAKE extendable output functions defined in FIPS 202.	Package sha3 implements the SHA-3 hash algorithms and the SHAKE extendable output functions defined in FIPS 202.
sha512 Package sha512 implements the SHA-384, SHA-512, SHA-512/224, and SHA-512/256 hash algorithms as defined in FIPS 180-4.	Package sha512 implements the SHA-384, SHA-512, SHA-512/224, and SHA-512/256 hash algorithms as defined in FIPS 180-4.
subtle Package subtle implements functions that are often useful in cryptographic code but require careful thought to use correctly.	Package subtle implements functions that are often useful in cryptographic code but require careful thought to use correctly.
tls Package tls partially implements TLS 1.2, as specified in RFC 5246, and TLS 1.3, as specified in RFC 8446.	Package tls partially implements TLS 1.2, as specified in RFC 5246, and TLS 1.3, as specified in RFC 8446.
internal/fips140tls Package fips140tls controls whether crypto/tls requires FIPS-approved settings.	Package fips140tls controls whether crypto/tls requires FIPS-approved settings.
x509 Package x509 implements a subset of the X.509 standard.	Package x509 implements a subset of the X.509 standard.
internal/macos Package macos provides cgo-less wrappers for Core Foundation and Security.framework, similarly to how package syscall provides access to libSystem.dylib.	Package macos provides cgo-less wrappers for Core Foundation and Security.framework, similarly to how package syscall provides access to libSystem.dylib.
pkix Package pkix contains shared, low level structures used for ASN.1 parsing and serialization of X.509 certificates, CRL and OCSP.	Package pkix contains shared, low level structures used for ASN.1 parsing and serialization of X.509 certificates, CRL and OCSP.