sha2.h

All headers

The SHA-2 family of hash functions.

  1. SHA-256 based hashes
  2. SHA224_CBLOCK
  3. SHA224_DIGEST_LENGTH
  4. SHA256_CBLOCK
  5. SHA256_DIGEST_LENGTH
  6. sha256_state_st
  7. SHA224_Init
  8. SHA224_Update
  9. SHA224_Final
  10. SHA224
  11. SHA256_Init
  12. SHA256_Update
  13. SHA256_Final
  14. SHA256
  15. SHA256_Transform
  16. SHA256_TransformBlocks
  17. SHA-512 based hashes
  18. SHA384_CBLOCK
  19. SHA384_DIGEST_LENGTH
  20. SHA512_CBLOCK
  21. SHA512_DIGEST_LENGTH
  22. SHA512_256_DIGEST_LENGTH
  23. sha512_state_st
  24. SHA384_Init
  25. SHA384_Update
  26. SHA384_Final
  27. SHA384
  28. SHA512_Init
  29. SHA512_Update
  30. SHA512_Final
  31. SHA512
  32. SHA512_Transform
  33. SHA512_256_Init
  34. SHA512_256_Update
  35. SHA512_256_Final
  36. SHA512_256

SHA-256 based hashes.

SHA224_CBLOCK is the block size of SHA-224.

#define SHA224_CBLOCK 64

SHA224_DIGEST_LENGTH is the length of a SHA-224 digest.

#define SHA224_DIGEST_LENGTH 28

SHA256_CBLOCK is the block size of SHA-256.

#define SHA256_CBLOCK 64

SHA256_DIGEST_LENGTH is the length of a SHA-256 digest.

#define SHA256_DIGEST_LENGTH 32
struct sha256_state_st {
  uint32_t h[8];
  uint32_t Nl, Nh;
  uint8_t data[SHA256_CBLOCK];
  unsigned num, md_len;
} /* SHA256_CTX */;

SHA224_Init initialises sha for SHA-224 and returns 1.

OPENSSL_EXPORT int SHA224_Init(SHA256_CTX *sha);

SHA224_Update adds len bytes from data to sha and returns 1.

sha must have been initialised for SHA-224.

OPENSSL_EXPORT int SHA224_Update(SHA256_CTX *sha, const void *data, size_t len);

SHA224_Final adds the final padding to sha and writes the resulting digest to out, which must have at least SHA224_DIGEST_LENGTH bytes of space. It returns 1.

sha must have been initialised for SHA-224.

OPENSSL_EXPORT int SHA224_Final(uint8_t out[SHA224_DIGEST_LENGTH],
                                SHA256_CTX *sha);

SHA224 writes the digest of len bytes from data to out and returns out. There must be at least SHA224_DIGEST_LENGTH bytes of space in out.

`static inline` to not generate such short-named linker symbols or macros.

static inline OPENSSL_UNUSED uint8_t* SHA224(
    const uint8_t* data, size_t len, uint8_t out[SHA224_DIGEST_LENGTH]) {
  SHA256_CTX ctx;
  SHA224_Init(&ctx);
  SHA224_Update(&ctx, data, len);
  SHA224_Final(out, &ctx);
  OPENSSL_cleanse(&ctx, sizeof(ctx));
  return out;
}

SHA256_Init initialises sha for SHA-256 and returns 1.

OPENSSL_EXPORT int SHA256_Init(SHA256_CTX *sha);

SHA256_Update adds len bytes from data to sha and returns 1.

sha must have been initialised for SHA-256.

OPENSSL_EXPORT int SHA256_Update(SHA256_CTX *sha, const void *data, size_t len);

SHA256_Final adds the final padding to sha and writes the resulting digest to out, which must have at least SHA256_DIGEST_LENGTH bytes of space. It returns one on success and zero on programmer error.

sha must have been initialised for SHA-256.

OPENSSL_EXPORT int SHA256_Final(uint8_t out[SHA256_DIGEST_LENGTH],
                                SHA256_CTX *sha);

SHA256 writes the digest of len bytes from data to out and returns out. There must be at least SHA256_DIGEST_LENGTH bytes of space in out.

`static inline` to not generate such short-named linker symbols or macros.

static inline OPENSSL_UNUSED uint8_t* SHA256(
    const uint8_t* data, size_t len, uint8_t out[SHA256_DIGEST_LENGTH]) {
  SHA256_CTX ctx;
  SHA256_Init(&ctx);
  SHA256_Update(&ctx, data, len);
  SHA256_Final(out, &ctx);
  OPENSSL_cleanse(&ctx, sizeof(ctx));
  return out;
}

SHA256_Transform is a low-level function that performs a single, SHA-256 block transformation using the state from sha and SHA256_CBLOCK bytes from block.

OPENSSL_EXPORT void SHA256_Transform(SHA256_CTX* sha,
                                     const uint8_t block[SHA256_CBLOCK]);

SHA256_TransformBlocks is a low-level function that takes num_blocks * SHA256_CBLOCK bytes of data and performs SHA-256 transforms on it to update state. You should not use this function unless you are implementing a derivative of SHA-256.

OPENSSL_EXPORT void SHA256_TransformBlocks(uint32_t state[8],
                                           const uint8_t *data,
                                           size_t num_blocks);

SHA-512 based hashes.

SHA384_CBLOCK is the block size of SHA-384.

#define SHA384_CBLOCK 128

SHA384_DIGEST_LENGTH is the length of a SHA-384 digest.

#define SHA384_DIGEST_LENGTH 48

SHA512_CBLOCK is the block size of SHA-512.

#define SHA512_CBLOCK 128

SHA512_DIGEST_LENGTH is the length of a SHA-512 digest.

#define SHA512_DIGEST_LENGTH 64

SHA512_256_DIGEST_LENGTH is the length of a SHA-512/256 digest.

See https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf section 5.3.6

#define SHA512_256_DIGEST_LENGTH 32
struct sha512_state_st {
  uint64_t h[8];
  uint16_t num, md_len;
  uint32_t bytes_so_far_high;
  uint64_t bytes_so_far_low;
  uint8_t p[SHA512_CBLOCK];
} /* SHA512_CTX */;

SHA384_Init initialises sha for SHA-384 and returns 1.

OPENSSL_EXPORT int SHA384_Init(SHA512_CTX *sha);

SHA384_Update adds len bytes from data to sha and returns 1.

sha must have been initialised for SHA-384.

OPENSSL_EXPORT int SHA384_Update(SHA512_CTX *sha, const void *data, size_t len);

SHA384_Final adds the final padding to sha and writes the resulting digest to out, which must have at least SHA384_DIGEST_LENGTH bytes of space. It returns one on success and zero on programmer error.

sha must have been initialised for SHA-384.

OPENSSL_EXPORT int SHA384_Final(uint8_t out[SHA384_DIGEST_LENGTH],
                                SHA512_CTX *sha);

SHA384 writes the digest of len bytes from data to out and returns out. There must be at least SHA384_DIGEST_LENGTH bytes of space in out.

`static inline` to not generate such short-named linker symbols or macros.

static inline OPENSSL_UNUSED uint8_t* SHA384(
    const uint8_t* data, size_t len, uint8_t out[SHA384_DIGEST_LENGTH]) {
  SHA512_CTX ctx;
  SHA384_Init(&ctx);
  SHA384_Update(&ctx, data, len);
  SHA384_Final(out, &ctx);
  OPENSSL_cleanse(&ctx, sizeof(ctx));
  return out;
}

SHA512_Init initialises sha and returns 1.

OPENSSL_EXPORT int SHA512_Init(SHA512_CTX *sha);

SHA512_Update adds len bytes from data to sha and returns 1.

sha must have been initialised for SHA-512.

OPENSSL_EXPORT int SHA512_Update(SHA512_CTX *sha, const void *data, size_t len);

SHA512_Final adds the final padding to sha and writes the resulting digest to out, which must have at least SHA512_DIGEST_LENGTH bytes of space. It returns one on success and zero on programmer error.

sha must have been initialised for SHA-512.

OPENSSL_EXPORT int SHA512_Final(uint8_t out[SHA512_DIGEST_LENGTH],
                                SHA512_CTX *sha);

SHA512 writes the digest of len bytes from data to out and returns out. There must be at least SHA512_DIGEST_LENGTH bytes of space in out.

`static inline` to not generate such short-named linker symbols or macros.

static inline OPENSSL_UNUSED uint8_t* SHA512(
    const uint8_t* data, size_t len, uint8_t out[SHA512_DIGEST_LENGTH]) {
  SHA512_CTX ctx;
  SHA512_Init(&ctx);
  SHA512_Update(&ctx, data, len);
  SHA512_Final(out, &ctx);
  OPENSSL_cleanse(&ctx, sizeof(ctx));
  return out;
}

SHA512_Transform is a low-level function that performs a single, SHA-512 block transformation using the state from sha and SHA512_CBLOCK bytes from block.

OPENSSL_EXPORT void SHA512_Transform(SHA512_CTX *sha,
                                     const uint8_t block[SHA512_CBLOCK]);

SHA512_256_Init initialises sha for SHA-512/256 and returns 1.

OPENSSL_EXPORT int SHA512_256_Init(SHA512_CTX *sha);

SHA512_256_Update adds len bytes from data to sha and returns 1.

sha must have been initialised for SHA-512/256.

OPENSSL_EXPORT int SHA512_256_Update(SHA512_CTX *sha, const void *data,
                                     size_t len);

SHA512_256_Final adds the final padding to sha and writes the resulting digest to out, which must have at least SHA512_256_DIGEST_LENGTH bytes of space. It returns one on success and zero on programmer error.

sha must have been initialised for SHA-512/256.

OPENSSL_EXPORT int SHA512_256_Final(uint8_t out[SHA512_256_DIGEST_LENGTH],
                                    SHA512_CTX *sha);

SHA512_256 writes the digest of len bytes from data to out and returns out. There must be at least SHA512_256_DIGEST_LENGTH bytes of space in out.

`static inline` to not generate such short-named linker symbols or macros.

static inline OPENSSL_UNUSED uint8_t* SHA512_256(
    const uint8_t* data, size_t len, uint8_t out[SHA512_256_DIGEST_LENGTH]) {
  SHA512_CTX ctx;
  SHA512_256_Init(&ctx);
  SHA512_256_Update(&ctx, data, len);
  SHA512_256_Final(out, &ctx);
  OPENSSL_cleanse(&ctx, sizeof(ctx));
  return out;
}