package boring

Import Path
	crypto/internal/boring (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 11 packages

Involved Source Files

	  d doc.go
		Package boring provides access to BoringCrypto implementation functions.
		Check the constant Enabled to find out whether BoringCrypto is available.
		If BoringCrypto is not available, the functions in this package all panic.

	    notboring.go
	    goboringcrypto.h
Package-Level Type Names (total 8, in which 7 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type BigInt ([])
		A BigInt is the raw words from a BigInt.
		This definition allows us to avoid importing math/big.
		Conversion between BigInt and *big.Int is in crypto/internal/boring/bbig.

		As Outputs Of (at least 3, all are exported)
			func GenerateKeyECDSA(curve string) (X, Y, D BigInt, err error)
			func GenerateKeyRSA(bits int) (N, E, D, P, Q, Dp, Dq, Qinv BigInt, err error)
			func crypto/internal/boring/bbig.Enc(b *big.Int) BigInt
		As Inputs Of (at least 5, all are exported)
			func NewPrivateKeyECDSA(curve string, X, Y, D BigInt) (*PrivateKeyECDSA, error)
			func NewPrivateKeyRSA(N, E, D, P, Q, Dp, Dq, Qinv BigInt) (*PrivateKeyRSA, error)
			func NewPublicKeyECDSA(curve string, X, Y BigInt) (*PublicKeyECDSA, error)
			func NewPublicKeyRSA(N, E BigInt) (*PublicKeyRSA, error)
			func crypto/internal/boring/bbig.Dec(b BigInt) *big.Int

	 type PrivateKeyECDH (struct)

		Methods (only one, which is exported)
			(*PrivateKeyECDH) PublicKey() (*PublicKeyECDH, error)
		As Outputs Of (at least 2, both are exported)
			func GenerateKeyECDH(string) (*PrivateKeyECDH, []byte, error)
			func NewPrivateKeyECDH(string, []byte) (*PrivateKeyECDH, error)
		As Inputs Of (at least 2, in which 1 is exported)
			func ECDH(*PrivateKeyECDH, *PublicKeyECDH) ([]byte, error)
			/* at least one unexported ... *//* at least one unexported: */
			func crypto/ecdh.newBoringPrivateKey(c ecdh.Curve, bk *PrivateKeyECDH, privateKey []byte) (*ecdh.PrivateKey, error)

	 type PrivateKeyECDSA (struct)

		As Outputs Of (at least 2, in which 1 is exported)
			func NewPrivateKeyECDSA(curve string, X, Y, D BigInt) (*PrivateKeyECDSA, error)
			/* at least one unexported ... *//* at least one unexported: */
			func crypto/ecdsa.boringPrivateKey(*ecdsa.PrivateKey) (*PrivateKeyECDSA, error)
		As Inputs Of (at least one exported)
			func SignMarshalECDSA(priv *PrivateKeyECDSA, hash []byte) ([]byte, error)

	 type PrivateKeyRSA (struct)

		As Outputs Of (at least 2, in which 1 is exported)
			func NewPrivateKeyRSA(N, E, D, P, Q, Dp, Dq, Qinv BigInt) (*PrivateKeyRSA, error)
			/* at least one unexported ... *//* at least one unexported: */
			func crypto/rsa.boringPrivateKey(*rsa.PrivateKey) (*PrivateKeyRSA, error)
		As Inputs Of (at least 5, all are exported)
			func DecryptRSANoPadding(priv *PrivateKeyRSA, ciphertext []byte) ([]byte, error)
			func DecryptRSAOAEP(h, mgfHash hash.Hash, priv *PrivateKeyRSA, ciphertext, label []byte) ([]byte, error)
			func DecryptRSAPKCS1(priv *PrivateKeyRSA, ciphertext []byte) ([]byte, error)
			func SignRSAPKCS1v15(priv *PrivateKeyRSA, h crypto.Hash, hashed []byte) ([]byte, error)
			func SignRSAPSS(priv *PrivateKeyRSA, h crypto.Hash, hashed []byte, saltLen int) ([]byte, error)

	 type PublicKeyECDH (struct)

		Methods (only one, which is exported)
			(*PublicKeyECDH) Bytes() []byte
		As Outputs Of (at least 2, both are exported)
			func NewPublicKeyECDH(string, []byte) (*PublicKeyECDH, error)
			func (*PrivateKeyECDH).PublicKey() (*PublicKeyECDH, error)
		As Inputs Of (at least one exported)
			func ECDH(*PrivateKeyECDH, *PublicKeyECDH) ([]byte, error)

	 type PublicKeyECDSA (struct)

		As Outputs Of (at least 2, in which 1 is exported)
			func NewPublicKeyECDSA(curve string, X, Y BigInt) (*PublicKeyECDSA, error)
			/* at least one unexported ... *//* at least one unexported: */
			func crypto/ecdsa.boringPublicKey(*ecdsa.PublicKey) (*PublicKeyECDSA, error)
		As Inputs Of (at least one exported)
			func VerifyECDSA(pub *PublicKeyECDSA, hash []byte, sig []byte) bool

	 type PublicKeyRSA (struct)

		As Outputs Of (at least 2, in which 1 is exported)
			func NewPublicKeyRSA(N, E BigInt) (*PublicKeyRSA, error)
			/* at least one unexported ... *//* at least one unexported: */
			func crypto/rsa.boringPublicKey(*rsa.PublicKey) (*PublicKeyRSA, error)
		As Inputs Of (at least 5, all are exported)
			func EncryptRSANoPadding(pub *PublicKeyRSA, msg []byte) ([]byte, error)
			func EncryptRSAOAEP(h, mgfHash hash.Hash, pub *PublicKeyRSA, msg, label []byte) ([]byte, error)
			func EncryptRSAPKCS1(pub *PublicKeyRSA, msg []byte) ([]byte, error)
			func VerifyRSAPKCS1v15(pub *PublicKeyRSA, h crypto.Hash, hashed, sig []byte) error
			func VerifyRSAPSS(pub *PublicKeyRSA, h crypto.Hash, hashed, sig []byte, saltLen int) error

	/* one unexported ... *//* one unexported: */
	 type randReader int (basic type)

		Methods (only one, which is exported)
			( randReader) Read(b []byte) (int, error)
		Implements (at least one exported)
			 randReader : io.Reader
		As Types Of (only one, which is exported)
			const RandReader


Package-Level Functions (total 37, all are exported)

	 func DecryptRSANoPadding(priv *PrivateKeyRSA, ciphertext []byte) ([]byte, error)
	 func DecryptRSAOAEP(h, mgfHash hash.Hash, priv *PrivateKeyRSA, ciphertext, label []byte) ([]byte, error)
	 func DecryptRSAPKCS1(priv *PrivateKeyRSA, ciphertext []byte) ([]byte, error)
	 func ECDH(*PrivateKeyECDH, *PublicKeyECDH) ([]byte, error)
	 func EncryptRSANoPadding(pub *PublicKeyRSA, msg []byte) ([]byte, error)
	 func EncryptRSAOAEP(h, mgfHash hash.Hash, pub *PublicKeyRSA, msg, label []byte) ([]byte, error)
	 func EncryptRSAPKCS1(pub *PublicKeyRSA, msg []byte) ([]byte, error)
	 func GenerateKeyECDH(string) (*PrivateKeyECDH, []byte, error)
	 func GenerateKeyECDSA(curve string) (X, Y, D BigInt, err error)
	 func GenerateKeyRSA(bits int) (N, E, D, P, Q, Dp, Dq, Qinv BigInt, err error)
	 func NewAESCipher(key []byte) (cipher.Block, error)
	 func NewGCMTLS(cipher.Block) (cipher.AEAD, error)
	 func NewHMAC(h func() hash.Hash, key []byte) hash.Hash
	 func NewPrivateKeyECDH(string, []byte) (*PrivateKeyECDH, error)
	 func NewPrivateKeyECDSA(curve string, X, Y, D BigInt) (*PrivateKeyECDSA, error)
	 func NewPrivateKeyRSA(N, E, D, P, Q, Dp, Dq, Qinv BigInt) (*PrivateKeyRSA, error)
	 func NewPublicKeyECDH(string, []byte) (*PublicKeyECDH, error)
	 func NewPublicKeyECDSA(curve string, X, Y BigInt) (*PublicKeyECDSA, error)
	 func NewPublicKeyRSA(N, E BigInt) (*PublicKeyRSA, error)
	 func NewSHA1() hash.Hash
	 func NewSHA224() hash.Hash
	 func NewSHA256() hash.Hash
	 func NewSHA384() hash.Hash
	 func NewSHA512() hash.Hash
	 func SHA1([]byte) [20]byte
	 func SHA224([]byte) [28]byte
	 func SHA256([]byte) [32]byte
	 func SHA384([]byte) [48]byte
	 func SHA512([]byte) [64]byte
	 func SignMarshalECDSA(priv *PrivateKeyECDSA, hash []byte) ([]byte, error)
	 func SignRSAPKCS1v15(priv *PrivateKeyRSA, h crypto.Hash, hashed []byte) ([]byte, error)
	 func SignRSAPSS(priv *PrivateKeyRSA, h crypto.Hash, hashed []byte, saltLen int) ([]byte, error)
	 func Unreachable()
		Unreachable marks code that should be unreachable
		when BoringCrypto is in use. It is a no-op without BoringCrypto.

	 func UnreachableExceptTests()
		UnreachableExceptTests marks code that should be unreachable
		when BoringCrypto is in use. It is a no-op without BoringCrypto.

	 func VerifyECDSA(pub *PublicKeyECDSA, hash []byte, sig []byte) bool
	 func VerifyRSAPKCS1v15(pub *PublicKeyRSA, h crypto.Hash, hashed, sig []byte) error
	 func VerifyRSAPSS(pub *PublicKeyRSA, h crypto.Hash, hashed, sig []byte, saltLen int) error
Package-Level Constants (total 3, in which 2 are exported)

	const Enabled = false
		Enabled reports whether BoringCrypto is available.
		When enabled is false, all functions in this package panic.
		
		BoringCrypto is only available on linux/amd64 systems.

	const RandReader randReader = 0
	/* one unexported ... *//* one unexported: */
	const available = false

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.