util.h File Reference

#include <openssl/bn.h>
#include <openssl/evp.h>
#include <stdbool.h>
#include <stdint.h>
#include <yubihsm.h>

Include dependency graph for util.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	YH_INTERNAL   __attribute__((visibility("hidden")))

Enumerations
enum	format_t { _base64 , _binary , _hex }

Functions
bool YH_INTERNAL	set_component (uint8_t *in_ptr, const BIGNUM *bn, int32_t element_len)
bool YH_INTERNAL	read_private_key (uint8_t *buf, size_t len, yh_algorithm *algo, uint8_t *bytes, size_t *bytes_len, bool internal_repr)
void YH_INTERNAL	format_digest (uint8_t *digest, char *str, uint16_t len)
int YH_INTERNAL	algo2nid (yh_algorithm algo)
bool YH_INTERNAL	algo2type (yh_algorithm algorithm, yh_object_type *type)
void YH_INTERNAL	parse_NID (uint8_t *data, uint16_t data_len, const EVP_MD **md_type, int *digestinfo_len)
bool YH_INTERNAL	read_file (FILE *fp, uint8_t *buf, size_t *buf_len)
bool YH_INTERNAL	write_file (const uint8_t *buf, size_t buf_len, FILE *fp, format_t format)
bool YH_INTERNAL	read_ed25519_key (uint8_t *in, size_t in_len, uint8_t *out, size_t *out_len)
bool YH_INTERNAL	write_ed25519_key (uint8_t *buf, size_t buf_len, FILE *fp, bool b64_encode)
bool YH_INTERNAL	base64_decode (const char *in, uint8_t *out, size_t *len)
bool YH_INTERNAL	hex_decode (const char *in, uint8_t *out, size_t *len)
bool YH_INTERNAL	split_hmac_key (yh_algorithm algorithm, uint8_t *in, size_t in_len, uint8_t *out, size_t *out_len)

Macro Definition Documentation

YH_INTERNAL

#define YH_INTERNAL   __attribute__((visibility("hidden")))

Definition at line 34 of file util.h.

Enumeration Type Documentation

format_t

enum format_t

Enumerator
_base64
_binary
_hex

Definition at line 27 of file util.h.

             {
  _base64,
  _binary,
  _hex,
} format_t;

Function Documentation

algo2nid()

int YH_INTERNAL algo2nid

(

yh_algorithm

algo

)

Definition at line 335 of file util.c.

                                {
  switch (algo) {
    case YH_ALGO_EC_P256:
      return NID_X9_62_prime256v1;
 
    case YH_ALGO_EC_P384:
      return NID_secp384r1;
 
    case YH_ALGO_EC_P521:
      return NID_secp521r1;
 
    case YH_ALGO_EC_P224:
      return NID_secp224r1;
 
    case YH_ALGO_EC_K256:
      return NID_secp256k1;
 
#ifdef NID_brainpoolP256r1
    case YH_ALGO_EC_BP256:
      return NID_brainpoolP256r1;
#endif
 
#ifdef NID_brainpoolP384r1
    case YH_ALGO_EC_BP384:
      return NID_brainpoolP384r1;
#endif
 
#ifdef NID_brainpoolP512r1
    case YH_ALGO_EC_BP512:
      return NID_brainpoolP512r1;
#endif
 
    default:
      return 0;
  }
 
  return 0;
}

Here is the caller graph for this function:

algo2type()

bool YH_INTERNAL algo2type	(	yh_algorithm	algorithm,
		yh_object_type *	type )

Definition at line 374 of file util.c.

                                                             {
 
  switch (algorithm) {
    case YH_ALGO_RSA_PKCS1_SHA1:
    case YH_ALGO_RSA_PKCS1_SHA256:
    case YH_ALGO_RSA_PKCS1_SHA384:
    case YH_ALGO_RSA_PKCS1_SHA512:
    case YH_ALGO_RSA_PSS_SHA1:
    case YH_ALGO_RSA_PSS_SHA256:
    case YH_ALGO_RSA_PSS_SHA384:
    case YH_ALGO_RSA_PSS_SHA512:
    case YH_ALGO_RSA_2048:
    case YH_ALGO_RSA_3072:
    case YH_ALGO_RSA_4096:
    case YH_ALGO_EC_P224:
    case YH_ALGO_EC_P256:
    case YH_ALGO_EC_P384:
    case YH_ALGO_EC_P521:
    case YH_ALGO_EC_K256:
    case YH_ALGO_EC_BP256:
    case YH_ALGO_EC_BP384:
    case YH_ALGO_EC_BP512:
    case YH_ALGO_EC_ECDSA_SHA1:
    case YH_ALGO_EC_ECDH:
    case YH_ALGO_RSA_OAEP_SHA1:
    case YH_ALGO_RSA_OAEP_SHA256:
    case YH_ALGO_RSA_OAEP_SHA384:
    case YH_ALGO_RSA_OAEP_SHA512:
    case YH_ALGO_EC_ECDSA_SHA256:
    case YH_ALGO_EC_ECDSA_SHA384:
    case YH_ALGO_EC_ECDSA_SHA512:
    case YH_ALGO_EC_ED25519:
      *type = YH_ASYMMETRIC_KEY;
      break;
 
    case YH_ALGO_HMAC_SHA1:
    case YH_ALGO_HMAC_SHA256:
    case YH_ALGO_HMAC_SHA384:
    case YH_ALGO_HMAC_SHA512:
      *type = YH_HMAC_KEY;
      break;
 
    case YH_ALGO_AES128_CCM_WRAP:
    case YH_ALGO_AES192_CCM_WRAP:
    case YH_ALGO_AES256_CCM_WRAP:
      *type = YH_WRAP_KEY;
      break;
 
    case YH_ALGO_OPAQUE_DATA:
    case YH_ALGO_OPAQUE_X509_CERTIFICATE:
      *type = YH_OPAQUE;
      break;
 
    case YH_ALGO_TEMPLATE_SSH:
      *type = YH_TEMPLATE;
      break;
 
    case YH_ALGO_AES128_YUBICO_OTP:
    case YH_ALGO_AES192_YUBICO_OTP:
    case YH_ALGO_AES256_YUBICO_OTP:
      *type = YH_OTP_AEAD_KEY;
      break;
 
    case YH_ALGO_AES128_YUBICO_AUTHENTICATION:
      *type = YH_AUTHENTICATION_KEY;
      break;
 
    case YH_ALGO_MGF1_SHA1:
    case YH_ALGO_MGF1_SHA256:
    case YH_ALGO_MGF1_SHA384:
    case YH_ALGO_MGF1_SHA512:
    default:
      return false;
  }
 
  return true;
}

Here is the caller graph for this function:

base64_decode()

bool YH_INTERNAL base64_decode	(	const char *	in,
		uint8_t *	out,
		size_t *	len )

Definition at line 503 of file util.c.

                                                              {
  int ret;
  BIO *b64 = BIO_new(BIO_f_base64());
  BIO *bio = BIO_new(BIO_s_mem());
  BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
  BIO_push(b64, bio);
 
  (void) BIO_write(bio, in, strlen(in));
  (void) BIO_flush(bio);
  ret = BIO_read(b64, out, *len);
 
  BIO_free_all(b64);
 
  if (ret <= 0) {
    return false;
  } else {
    *len = ret;
    return true;
  }
}

format_digest()

void YH_INTERNAL format_digest	(	uint8_t *	digest,
		char *	str,
		uint16_t	len )

Definition at line 326 of file util.c.

                                                             {
 
  for (uint32_t i = 0; i < len; i++) {
    sprintf(str + (2 * i), "%02x", digest[i]);
  }
 
  str[2 * len] = '\0';
}

Here is the caller graph for this function:

hex_decode()

bool YH_INTERNAL hex_decode	(	const char *	in,
		uint8_t *	out,
		size_t *	len )

Definition at line 524 of file util.c.

                                                           {
  int pos = 0;
  size_t in_len = strlen(in);
  if (in[in_len - 1] == '\n') {
    in_len--;
  }
  if (in[in_len - 1] == '\r') {
    in_len--;
  }
  if (in_len % 2 != 0) {
    return false;
  } else if (in_len / 2 > *len) {
    return false;
  }
 
  for (size_t i = 0; i < in_len / 2; i++) {
    char *endptr = NULL;
    char buf[3] = {0};
    long num;
    errno = 0;
 
    buf[0] = in[pos];
    buf[1] = in[pos + 1];
    num = strtol((const char *) buf, &endptr, 16);
    if ((errno == ERANGE && (num < 0 || num > UCHAR_MAX)) ||
        (errno != 0 && num == 0) || *endptr != '\0') {
      return false;
    }
    out[i] = (uint8_t) num;
    pos += 2;
  }
  *len = in_len / 2;
  return true;
}

Here is the caller graph for this function:

parse_NID()

void YH_INTERNAL parse_NID	(	uint8_t *	data,
		uint16_t	data_len,
		const EVP_MD **	md_type,
		int *	digestinfo_len )

Definition at line 452 of file util.c.

                                    {
  if (data_len >= sizeof(sha1oid) &&
      memcmp(sha1oid, data, sizeof(sha1oid)) == 0) {
    *md_type = EVP_sha1();
    *digestinfo_len = sizeof(sha1oid);
  } else if (data_len >= sizeof(sha256oid) &&
             memcmp(sha256oid, data, sizeof(sha256oid)) == 0) {
    *md_type = EVP_sha256();
    *digestinfo_len = sizeof(sha256oid);
  } else if (data_len >= sizeof(sha384oid) &&
             memcmp(sha384oid, data, sizeof(sha384oid)) == 0) {
    *md_type = EVP_sha384();
    *digestinfo_len = sizeof(sha384oid);
  } else if (data_len >= sizeof(sha512oid) &&
             memcmp(sha512oid, data, sizeof(sha512oid)) == 0) {
    *md_type = EVP_sha512();
    *digestinfo_len = sizeof(sha512oid);
  } else {
    *md_type = EVP_md_null();
    *digestinfo_len = 0;
  }
}

Here is the caller graph for this function:

read_ed25519_key()

bool YH_INTERNAL read_ed25519_key	(	uint8_t *	in,
		size_t	in_len,
		uint8_t *	out,
		size_t *	out_len )

Definition at line 77 of file util.c.

                                       {
 
  uint8_t decoded[128];
  size_t decoded_len = sizeof(decoded);
 
  if (memcmp(in, PEM_private_header, 28) != 0 ||
      memcmp(in + in_len - 26, PEM_private_trailer, 25) != 0) {
    return false;
  }
 
  int ret;
  BIO *b64 = BIO_new(BIO_f_base64());
  BIO *bio = BIO_new(BIO_s_mem());
  BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
  BIO_push(b64, bio);
 
  (void) BIO_write(bio, in + 28, in_len - 28 - 25);
  (void) BIO_flush(bio);
  ret = BIO_read(b64, decoded, decoded_len);
 
  BIO_free_all(b64);
 
  if (ret <= 0 || ret != 48) {
    return false;
  }
 
  if (memcmp(decoded, ed25519private_oid, sizeof(ed25519private_oid)) != 0) {
    return false;
  }
 
  memcpy(out, decoded + 16, 32);
  *out_len = 32;
 
  insecure_memzero(decoded, 48);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

read_file()

bool YH_INTERNAL read_file	(	FILE *	fp,
		uint8_t *	buf,
		size_t *	buf_len )

Definition at line 476 of file util.c.

                                                        {
  size_t n = 0;
  size_t available = *buf_len;
  uint8_t *p = buf;
 
  do {
    n = fread(p, 1, available, fp);
    available -= n;
    p += n;
  } while (!feof(fp) && !ferror(fp) && available > 0);
 
  if (ferror(fp)) {
    return false;
  }
 
  if (!feof(fp) && available == 0) {
    uint8_t b[1];
    n = fread(b, 1, 1, fp);
    if (!feof(fp)) {
      return false;
    }
  }
 
  *buf_len = p - buf;
  return true;
}

Here is the caller graph for this function:

read_private_key()

bool YH_INTERNAL read_private_key	(	uint8_t *	buf,
		size_t	len,
		yh_algorithm *	algo,
		uint8_t *	bytes,
		size_t *	bytes_len,
		bool	internal_repr )

Definition at line 116 of file util.c.

                                                                             {
 
  if (read_ed25519_key(buf, len, bytes, bytes_len) == true) {
    *algo = YH_ALGO_EC_ED25519;
    return true;
  }
 
  EVP_PKEY *private_key;
 
  BIO *bio = BIO_new(BIO_s_mem());
  if (bio == NULL) {
    return false;
  }
 
  (void) BIO_write(bio, buf, len);
 
  private_key = PEM_read_bio_PrivateKey(bio, NULL, NULL, /*password*/ NULL);
  BIO_free_all(bio);
  if (private_key == NULL) {
    return false;
  }
 
  bool ret = false;
 
  RSA *rsa = NULL;
 
  BIGNUM *x = NULL;
  BIGNUM *y = NULL;
  EC_KEY *ec_private = NULL;
 
  switch (EVP_PKEY_base_id(private_key)) {
    case EVP_PKEY_RSA: {
      rsa = EVP_PKEY_get1_RSA(private_key);
      unsigned char e[4];
      int size = RSA_size(rsa);
      const BIGNUM *bn_n, *bn_e, *bn_p, *bn_q;
 
      RSA_get0_key(rsa, &bn_n, &bn_e, NULL);
      RSA_get0_factors(rsa, &bn_p, &bn_q);
 
      if (set_component(e, bn_e, 3) == false ||
          !(e[0] == 0x01 && e[1] == 0x00 && e[2] == 0x01)) {
        goto cleanup;
      }
 
      if (size == 256) {
        *algo = YH_ALGO_RSA_2048;
      } else if (size == 384) {
        *algo = YH_ALGO_RSA_3072;
      } else if (size == 512) {
        *algo = YH_ALGO_RSA_4096;
      } else {
        goto cleanup;
      }
 
      if (set_component(bytes, bn_p, size / 2) == false) {
        goto cleanup;
      }
 
      if (set_component(bytes + size / 2, bn_q, size / 2) == false) {
        goto cleanup;
      }
 
      if (internal_repr == true) {
        const BIGNUM *dmp1, *dmq1, *iqmp;
        uint8_t *ptr = bytes + size;
 
        RSA_get0_crt_params(rsa, &dmp1, &dmq1, &iqmp);
        if (set_component(ptr, dmp1, size / 2) == false) {
          goto cleanup;
        }
        ptr += size / 2;
 
        if (set_component(ptr, dmq1, size / 2) == false) {
          goto cleanup;
        }
        ptr += size / 2;
 
        if (set_component(ptr, iqmp, size / 2) == false) {
          goto cleanup;
        }
        ptr += size / 2;
 
        if (set_component(ptr, bn_n, size) == false) {
          goto cleanup;
        }
 
        *bytes_len = (size / 2) * 7;
      } else {
        *bytes_len = size;
      }
    } break;
 
    case EVP_PKEY_EC: {
      ec_private = EVP_PKEY_get1_EC_KEY(private_key);
      if (ec_private == NULL) {
        goto cleanup;
      }
 
      const BIGNUM *s = EC_KEY_get0_private_key(ec_private);
      const EC_GROUP *group = EC_KEY_get0_group(ec_private);
      int curve = EC_GROUP_get_curve_name(group);
      int size = 0;
 
      if (curve == NID_X9_62_prime256v1) {
        *algo = YH_ALGO_EC_P256;
        size = 32;
      } else if (curve == NID_secp384r1) {
        *algo = YH_ALGO_EC_P384;
        size = 48;
      } else if (curve == NID_secp521r1) {
        *algo = YH_ALGO_EC_P521;
        size = 66;
      } else if (curve == NID_secp224r1) {
        *algo = YH_ALGO_EC_P224;
        size = 28;
#ifdef NID_brainpoolP256r1
      } else if (curve == NID_brainpoolP256r1) {
        *algo = YH_ALGO_EC_BP256;
        size = 32;
#endif
#ifdef NID_brainpoolP384r1
      } else if (curve == NID_brainpoolP384r1) {
        *algo = YH_ALGO_EC_BP384;
        size = 48;
#endif
#ifdef NID_brainpoolP512r1
      } else if (curve == NID_brainpoolP512r1) {
        *algo = YH_ALGO_EC_BP512;
        size = 64;
#endif
      } else if (curve == NID_secp256k1) {
        *algo = YH_ALGO_EC_K256;
        size = 32;
      } else {
        goto cleanup;
      }
 
      if (set_component(bytes, s, size) == false) {
        goto cleanup;
      }
 
      if (internal_repr == true) {
        const EC_POINT *ec_public = EC_KEY_get0_public_key(ec_private);
 
        x = BN_new();
        if (x == NULL) {
          goto cleanup;
        }
 
        y = BN_new();
        if (y == NULL) {
          goto cleanup;
        }
 
        if (EC_POINT_get_affine_coordinates_GFp(group, ec_public, x, y, NULL) ==
            0) {
          goto cleanup;
        }
 
        uint8_t *ptr = bytes + size;
        if (set_component(ptr, x, size) == false) {
          goto cleanup;
        }
        ptr += size;
 
        if (set_component(ptr, y, size) == false) {
          goto cleanup;
        }
 
        *bytes_len = size * 3;
      } else {
        *bytes_len = size;
      }
    } break;
 
    default:
      goto cleanup;
  }
 
  ret = true;
 
cleanup:
 
  if (rsa != NULL) {
    RSA_free(rsa);
    rsa = NULL;
  }
 
  if (x != NULL) {
    BN_free(x);
    x = NULL;
  }
 
  if (y != NULL) {
    BN_free(y);
    y = NULL;
  }
 
  if (ec_private != NULL) {
    EC_KEY_free(ec_private);
    ec_private = NULL;
  }
 
  EVP_PKEY_free(private_key);
 
  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

set_component()

bool YH_INTERNAL set_component	(	uint8_t *	in_ptr,
		const BIGNUM *	bn,
		int32_t	element_len )

split_hmac_key()

bool YH_INTERNAL split_hmac_key	(	yh_algorithm	algorithm,
		uint8_t *	in,
		size_t	in_len,
		uint8_t *	out,
		size_t *	out_len )

Definition at line 653 of file util.c.

                                                   {
 
  uint8_t key[128 * 2] = {0};
  uint8_t block_size;
 
  switch (algorithm) {
    case YH_ALGO_HMAC_SHA1:
      block_size = EVP_MD_block_size(EVP_sha1());
      break;
 
    case YH_ALGO_HMAC_SHA256:
      block_size = EVP_MD_block_size(EVP_sha256());
      break;
 
    case YH_ALGO_HMAC_SHA384:
      block_size = EVP_MD_block_size(EVP_sha384());
      break;
 
    case YH_ALGO_HMAC_SHA512:
      block_size = EVP_MD_block_size(EVP_sha512());
      break;
 
    default:
      return false;
  }
 
  if (in_len > block_size) {
    return false; // TODO(adma): hash the key
  }
 
  memcpy(key, in, in_len);
 
  for (uint8_t i = 0; i < block_size; i++) {
    out[i] = key[i] ^ 0x36;
    out[i + block_size] = key[i] ^ 0x5c;
  }
 
  *out_len = 2 * block_size;
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

write_ed25519_key()

bool YH_INTERNAL write_ed25519_key	(	uint8_t *	buf,
		size_t	buf_len,
		FILE *	fp,
		bool	b64_encode )

Definition at line 622 of file util.c.

                                        {
 
  if (b64_encode == true) {
    uint8_t newline = '\n';
    uint8_t asn1[64];
    uint8_t padding = 0;
 
    if ((buf[0] & 0x80) != 0) {
      padding = 1;
    }
 
    memcpy(asn1, ed25519public_oid, sizeof(ed25519public_oid));
    asn1[1] += padding;
    memset(asn1 + sizeof(ed25519public_oid), 0, padding);
    asn1[10] += padding;
    memcpy(asn1 + sizeof(ed25519public_oid) + padding, buf, buf_len);
 
    write_file((uint8_t *) PEM_public_header, sizeof(PEM_public_header) - 1, fp,
               false);
    write_file(asn1, sizeof(ed25519public_oid) + padding + buf_len, fp, true);
    write_file(&newline, 1, fp, false);
    write_file((uint8_t *) PEM_public_trailer, sizeof(PEM_public_trailer) - 1,
               fp, false);
  } else {
    write_file(buf, buf_len, fp, false);
  }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

write_file()

bool YH_INTERNAL write_file	(	const uint8_t *	buf,
		size_t	buf_len,
		FILE *	fp,
		format_t	format )

Definition at line 559 of file util.c.

                                                                               {
 
  const uint8_t *p = buf;
  uint8_t *data = NULL;
  size_t length = buf_len;
  size_t written = 0;
  BIO *b64 = NULL;
 
  if (format == _base64) {
    BIO *bio;
    BUF_MEM *bufferPtr;
 
    b64 = BIO_new(BIO_f_base64());
    bio = BIO_new(BIO_s_mem());
    bio = BIO_push(b64, bio);
 
    (void) BIO_set_flags(bio, BIO_FLAGS_BASE64_NO_NL);
    (void) BIO_write(bio, buf, buf_len);
    (void) BIO_flush(bio);
    (void) BIO_get_mem_ptr(bio, &bufferPtr);
    p = (uint8_t *) bufferPtr->data;
    length = bufferPtr->length;
  } else if (format == _hex) {
    data = calloc(buf_len * 2 + 1, 1);
    if (data == NULL) {
      return false;
    }
    for (size_t i = 0; i < buf_len; i++) {
      sprintf((char *) data + i * 2, "%02x", buf[i]);
    }
    p = data;
    length = buf_len * 2;
  }
 
  do {
    written = fwrite(p, 1, length, fp);
    length -= written;
    p += written;
  } while (!feof(fp) && !ferror(fp) && length > 0);
 
  if (fp == stdout || fp == stderr) {
    fprintf(fp, "\n");
  }
 
  if (b64 != NULL) {
    BIO_free_all(b64);
    b64 = NULL;
  }
 
  if (data != NULL) {
    free(data);
    data = NULL;
  }
 
  if (ferror(fp) || feof(fp)) {
    return false;
  }
 
  fflush(fp);
 
  return true;
}

Here is the caller graph for this function: