Run Format

Package crypto

import "crypto"

Overview ▾

Package crypto collects common cryptographic constants.

func RegisterHash

func RegisterHash(h Hash, f func() hash.Hash)

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.

type Hash

type Hash uint

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

const (
    MD4       Hash = 1 + iota // import code.google.com/p/go.crypto/md4
    MD5                       // import crypto/md5
    SHA1                      // import crypto/sha1
    SHA224                    // import crypto/sha256
    SHA256                    // import crypto/sha256
    SHA384                    // import crypto/sha512
    SHA512                    // import crypto/sha512
    MD5SHA1                   // no implementation; MD5+SHA1 used for TLS RSA
    RIPEMD160                 // import code.google.com/p/go.crypto/ripemd160
    SHA3_224                  // import code.google.com/p/go.crypto/sha3
    SHA3_256                  // import code.google.com/p/go.crypto/sha3
    SHA3_384                  // import code.google.com/p/go.crypto/sha3
    SHA3_512                  // import code.google.com/p/go.crypto/sha3


func (Hash) Available

func (h Hash) Available() bool

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

func (Hash) HashFunc

func (h Hash) HashFunc() Hash

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

func (Hash) New

func (h Hash) New() hash.Hash

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

func (Hash) Size

func (h Hash) Size() int

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.

type PrivateKey

type PrivateKey interface{}

PrivateKey represents a private key using an unspecified algorithm.

type PublicKey

type PublicKey interface{}

PublicKey represents a public key using an unspecified algorithm.

type Signer

type Signer interface {
    // Public returns the public key corresponding to the opaque,
    // private key.
    Public() PublicKey

    // Sign signs msg with the private key, possibly using entropy from
    // rand. For an RSA key, the resulting signature should be either a
    // PKCS#1 v1.5 or PSS signature (as indicated by opts). For an (EC)DSA
    // key, it should be a DER-serialised, ASN.1 signature structure.
    // Hash implements the SignerOpts interface and, in most cases, one can
    // simply pass in the hash function used as opts. Sign may also attempt
    // to type assert opts to other types in order to obtain algorithm
    // specific values. See the documentation in each package for details.
    Sign(rand io.Reader, msg []byte, opts SignerOpts) (signature []byte, err error)

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

type SignerOpts interface {
    // HashFunc returns an identifier for the hash function used to produce
    // the message passed to Signer.Sign, or else zero to indicate that no
    // hashing was done.
    HashFunc() Hash

SignerOpts contains options for signing with a Signer.


Name      Synopsis
aes      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.
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.
dsa      Package dsa implements the Digital Signature Algorithm, as defined in FIPS 186-3.
ecdsa      Package ecdsa implements the Elliptic Curve Digital Signature Algorithm, as defined in FIPS 186-3.
elliptic      Package elliptic implements several standard elliptic curves over prime fields.
hmac      Package hmac implements the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198.
md5      Package md5 implements the MD5 hash algorithm as defined in RFC 1321.
rand      Package rand implements a cryptographically secure pseudorandom number generator.
rc4      Package rc4 implements RC4 encryption, as defined in Bruce Schneier's Applied Cryptography.
rsa      Package rsa implements RSA encryption as specified in PKCS#1.
sha1      Package sha1 implements the SHA1 hash algorithm as defined in RFC 3174.
sha256      Package sha256 implements the SHA224 and SHA256 hash algorithms as defined in FIPS 180-4.
sha512      Package sha512 implements the SHA384 and SHA512 hash algorithms as defined in FIPS 180-2.
subtle      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.
x509      Package x509 parses X.509-encoded keys and certificates.
     pkix      Package pkix contains shared, low level structures used for ASN.1 parsing and serialization of X.509 certificates, CRL and OCSP.