rsa

Documentation

Index

• Variables
• func DecryptOAEP(hash, mgfHash hash.Hash, priv *PrivateKey, ciphertext []byte, label []byte) ([]byte, error)
• func DecryptWithCheck(priv *PrivateKey, ciphertext []byte) ([]byte, error)
• func DecryptWithoutCheck(priv *PrivateKey, ciphertext []byte) ([]byte, error)
• func Encrypt(pub *PublicKey, plaintext []byte) ([]byte, error)
• func EncryptOAEP(hash, mgfHash hash.Hash, random io.Reader, pub *PublicKey, msg []byte, ...) ([]byte, error)
• func PSSMaxSaltLength(pub *PublicKey, hash hash.Hash) (int, error)
• func SignPKCS1v15(priv *PrivateKey, hash string, hashed []byte) ([]byte, error)
• func SignPSS(rand io.Reader, priv *PrivateKey, hash hash.Hash, hashed []byte, ...) ([]byte, error)
• func TestingOnlyLargeExponentDecryptOAEP(hash, mgfHash hash.Hash, priv *TestingOnlyLargeExponentPrivateKey, ...) ([]byte, error)
• func TestingOnlyLargeExponentEncryptOAEP(hash, mgfHash hash.Hash, random io.Reader, ...) ([]byte, error)
• func TestingOnlyLargeExponentVerifyPKCS1v15(pub *TestingOnlyLargeExponentPublicKey, hash string, hashed []byte, sig []byte) error
• func TestingOnlyLargeExponentVerifyPSS(pub *TestingOnlyLargeExponentPublicKey, hash hash.Hash, digest []byte, ...) error
• func VerifyPKCS1v15(pub *PublicKey, hash string, hashed []byte, sig []byte) error
• func VerifyPSS(pub *PublicKey, hash hash.Hash, digest []byte, sig []byte) error
• func VerifyPSSWithSaltLength(pub *PublicKey, hash hash.Hash, digest []byte, sig []byte, saltLength int) error
• type PrivateKey
  • func GenerateKey(rand io.Reader, bits int) (*PrivateKey, error)
  • func NewPrivateKey(N []byte, e int, d, P, Q []byte) (*PrivateKey, error)
  • func NewPrivateKeyWithPrecomputation(N []byte, e int, d, P, Q, dP, dQ, qInv []byte) (*PrivateKey, error)
  • func NewPrivateKeyWithoutCRT(N []byte, e int, d []byte) (*PrivateKey, error)
  • func (priv *PrivateKey) Export() (N []byte, e int, d, P, Q, dP, dQ, qInv []byte)
  • func (priv *PrivateKey) PublicKey() *PublicKey
• type PublicKey
  • func (pub *PublicKey) Size() int
• type TestingOnlyLargeExponentPrivateKey
  • func TestingOnlyNewLargeExponentPrivateKeyWithPrecomputation(N []byte, e []byte, d, P, Q, dP, dQ, qInv []byte) (*TestingOnlyLargeExponentPrivateKey, error)
  • func (priv *TestingOnlyLargeExponentPrivateKey) Size() int
• type TestingOnlyLargeExponentPublicKey
  • func (pub *TestingOnlyLargeExponentPublicKey) Size() int

Variables

var ErrDecryption = errors.New("crypto/rsa: decryption error")

var ErrMessageTooLong = errors.New("crypto/rsa: message too long for RSA key size")

var ErrVerification = errors.New("crypto/rsa: verification error")

Functions

func DecryptOAEP

func DecryptOAEP(hash, mgfHash hash.Hash, priv *PrivateKey, ciphertext []byte, label []byte) ([]byte, error)

DecryptOAEP decrypts ciphertext using RSAES-OAEP.

func DecryptWithCheck

func DecryptWithCheck(priv *PrivateKey, ciphertext []byte) ([]byte, error)

DecryptWithCheck performs the RSA private key operation and checks the result to defend against errors in the CRT computation.

func DecryptWithoutCheck

func DecryptWithoutCheck(priv *PrivateKey, ciphertext []byte) ([]byte, error)

DecryptWithoutCheck performs the RSA private key operation.

func Encrypt

func Encrypt(pub *PublicKey, plaintext []byte) ([]byte, error)

Encrypt performs the RSA public key operation.

func EncryptOAEP

func EncryptOAEP(hash, mgfHash hash.Hash, random io.Reader, pub *PublicKey, msg []byte, label []byte) ([]byte, error)

EncryptOAEP encrypts the given message with RSAES-OAEP.

func PSSMaxSaltLength

func PSSMaxSaltLength(pub *PublicKey, hash hash.Hash) (int, error)

PSSMaxSaltLength returns the maximum salt length for a given public key and hash function.

func SignPKCS1v15

func SignPKCS1v15(priv *PrivateKey, hash string, hashed []byte) ([]byte, error)

SignPKCS1v15 calculates an RSASSA-PKCS1-v1.5 signature.

hash is the name of the hash function as returned by crypto.Hash.String or the empty string to indicate that the message is signed directly.

func SignPSS

func SignPSS(rand io.Reader, priv *PrivateKey, hash hash.Hash, hashed []byte, saltLength int) ([]byte, error)

SignPSS calculates the signature of hashed using RSASSA-PSS.

func TestingOnlyLargeExponentDecryptOAEP

func TestingOnlyLargeExponentDecryptOAEP(hash, mgfHash hash.Hash, priv *TestingOnlyLargeExponentPrivateKey, ciphertext []byte, label []byte) ([]byte, error)

TestingOnlyLargeExponentDecryptOAEP decrypts ciphertext using RSAES-OAEP with a private key that has a large public exponent. It is only meant for ACVP testing.

func TestingOnlyLargeExponentEncryptOAEP

func TestingOnlyLargeExponentEncryptOAEP(hash, mgfHash hash.Hash, random io.Reader, pub *TestingOnlyLargeExponentPublicKey, msg []byte, label []byte) ([]byte, error)

TestingOnlyLargeExponentEncryptOAEP encrypts the given message with RSAES-OAEP using a public key with a large exponent. It is only meant for ACVP testing.

func TestingOnlyLargeExponentVerifyPKCS1v15

func TestingOnlyLargeExponentVerifyPKCS1v15(pub *TestingOnlyLargeExponentPublicKey, hash string, hashed []byte, sig []byte) error

func TestingOnlyLargeExponentVerifyPSS

func TestingOnlyLargeExponentVerifyPSS(pub *TestingOnlyLargeExponentPublicKey, hash hash.Hash, digest []byte, sig []byte) error

func VerifyPKCS1v15

func VerifyPKCS1v15(pub *PublicKey, hash string, hashed []byte, sig []byte) error

VerifyPKCS1v15 verifies an RSASSA-PKCS1-v1.5 signature.

hash is the name of the hash function as returned by crypto.Hash.String or the empty string to indicate that the message is signed directly.

func VerifyPSS

func VerifyPSS(pub *PublicKey, hash hash.Hash, digest []byte, sig []byte) error

VerifyPSS verifies sig with RSASSA-PSS automatically detecting the salt length.

func VerifyPSSWithSaltLength

func VerifyPSSWithSaltLength(pub *PublicKey, hash hash.Hash, digest []byte, sig []byte, saltLength int) error

VerifyPSSWithSaltLength verifies sig with RSASSA-PSS and an expected salt length.

Types

type PrivateKey

type PrivateKey struct {
	// contains filtered or unexported fields
}

func GenerateKey

func GenerateKey(rand io.Reader, bits int) (*PrivateKey, error)

GenerateKey generates a new RSA key pair of the given bit size. bits must be at least 32.

It follows the process described at c2sp.org/det-keygen, which is compliant with FIPS 186-5, Appendix A.1, IFC Key Pair Generation and FIPS 186-5, Appendix A.1.3, Generation of Random Primes that are Probably Prime. The prime candidates are drawn from rand, which in production will be the global DRBG, while in tests can be an HMAC_DRBG as specified in c2sp.org/det-keygen, to allow using its tests vectors.

func NewPrivateKey

func NewPrivateKey(N []byte, e int, d, P, Q []byte) (*PrivateKey, error)

NewPrivateKey creates a new RSA private key from the given parameters.

All values are in big-endian byte slice format, and may have leading zeros or be shorter if leading zeroes were trimmed.

func NewPrivateKeyWithPrecomputation

func NewPrivateKeyWithPrecomputation(N []byte, e int, d, P, Q, dP, dQ, qInv []byte) (*PrivateKey, error)

NewPrivateKeyWithPrecomputation creates a new RSA private key from the given parameters, which include precomputed CRT values.

func NewPrivateKeyWithoutCRT

func NewPrivateKeyWithoutCRT(N []byte, e int, d []byte) (*PrivateKey, error)

NewPrivateKeyWithoutCRT creates a new RSA private key from the given parameters.

This is meant for deprecated multi-prime keys, and is not FIPS 140 compliant.

func (*PrivateKey) Export

func (priv *PrivateKey) Export() (N []byte, e int, d, P, Q, dP, dQ, qInv []byte)

Export returns the key parameters in big-endian byte slice format.

P, Q, dP, dQ, and qInv may be nil if the key was created with NewPrivateKeyWithoutCRT.

func (*PrivateKey) PublicKey

func (priv *PrivateKey) PublicKey() *PublicKey

type PublicKey

type PublicKey struct {
	N *bigmod.Modulus
	E int
}

func (*PublicKey) Size

func (pub *PublicKey) Size() int

Size returns the modulus size in bytes. Raw signatures and ciphertexts for or by this public key will have the same size.

type TestingOnlyLargeExponentPrivateKey

type TestingOnlyLargeExponentPrivateKey struct {
	// contains filtered or unexported fields
}

TestingOnlyLargeExponentPrivateKey is a variant of PrivateKey that supports large public exponents. It is only meant for supporting the full ACVP test suite. This type must not be used in production code.

func TestingOnlyNewLargeExponentPrivateKeyWithPrecomputation

func TestingOnlyNewLargeExponentPrivateKeyWithPrecomputation(N []byte, e []byte, d, P, Q, dP, dQ, qInv []byte) (*TestingOnlyLargeExponentPrivateKey, error)

TestingOnlyNewLargeExponentPrivateKeyWithPrecomputation creates a new RSA private key with a large public exponent from the given parameters. It is only meant for ACVP testing.

func (*TestingOnlyLargeExponentPrivateKey) Size

func (priv *TestingOnlyLargeExponentPrivateKey) Size() int

type TestingOnlyLargeExponentPublicKey

type TestingOnlyLargeExponentPublicKey struct {
	N *bigmod.Modulus
	// E is the public exponent, represented as a big-endian byte slice.
	E []byte
}

TestingOnlyLargeExponentPublicKey is a variant of PublicKey that supports large public exponents. It is only meant for supporting the full ACVP test suite, which unfortunately forces us to choose between a fixed exponent and the full (2¹⁶, 2²⁵⁶) range. This type must not be used in production code, nor for e values < 2³¹, which instead must use PublicKey.

func (*TestingOnlyLargeExponentPublicKey) Size

func (pub *TestingOnlyLargeExponentPublicKey) Size() int