keys.h

Go to the documentation of this file.

/*
 * 
 * keys.h
 *
 * priv key definitions
 *
 * a Net::DNS like library for C
 *
 * (c) NLnet Labs, 2005-2006
 *
 * See the file LICENSE for the license
 */
 
#ifndef LDNS_KEYS_H
#define LDNS_KEYS_H
 
#include <ldns/common.h>
#if LDNS_BUILD_CONFIG_HAVE_SSL
#include <openssl/ssl.h>
#endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
#include <ldns/util.h>
#include <errno.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern ldns_lookup_table ldns_signing_algorithms[];
 
#define LDNS_KEY_ZONE_KEY 0x0100   /* rfc 4034 */
#define LDNS_KEY_SEP_KEY 0x0001    /* rfc 4034 */
#define LDNS_KEY_REVOKE_KEY 0x0080 /* rfc 5011 */
 
enum ldns_enum_algorithm
{
        LDNS_RSAMD5             = 1,   /* RFC 4034,4035 */
        LDNS_DH                 = 2,
#if LDNS_BUILD_CONFIG_USE_DSA
        LDNS_DSA                = 3,
#endif /* LDNS_BUILD_CONFIG_USE_DSA */
        LDNS_ECC                = 4,
        LDNS_RSASHA1            = 5,
#if LDNS_BUILD_CONFIG_USE_DSA
        LDNS_DSA_NSEC3          = 6,
#endif /* LDNS_BUILD_CONFIG_USE_DSA */
        LDNS_RSASHA1_NSEC3      = 7,
        LDNS_RSASHA256          = 8,   /* RFC 5702 */
        LDNS_RSASHA512          = 10,  /* RFC 5702 */
        LDNS_ECC_GOST           = 12,  /* RFC 5933 */
        LDNS_ECDSAP256SHA256    = 13,  /* RFC 6605 */
        LDNS_ECDSAP384SHA384    = 14,  /* RFC 6605 */
#if LDNS_BUILD_CONFIG_USE_ED25519
        LDNS_ED25519            = 15,  /* RFC 8080 */
#endif /* LDNS_BUILD_CONFIG_USE_ED25519 */
#if LDNS_BUILD_CONFIG_USE_ED448
        LDNS_ED448              = 16,  /* RFC 8080 */
#endif /* LDNS_BUILD_CONFIG_USE_ED448 */
        LDNS_INDIRECT           = 252,
        LDNS_PRIVATEDNS         = 253,
        LDNS_PRIVATEOID         = 254
};
typedef enum ldns_enum_algorithm ldns_algorithm;
 
enum ldns_enum_hash
{
        LDNS_SHA1               = 1,  /* RFC 4034 */
        LDNS_SHA256             = 2,  /* RFC 4509 */
        LDNS_HASH_GOST          = 3,  /* RFC 5933 */
        LDNS_SHA384             = 4   /* RFC 6605 */
};
typedef enum ldns_enum_hash ldns_hash;
 
enum ldns_enum_signing_algorithm
{
        LDNS_SIGN_RSAMD5         = LDNS_RSAMD5,
        LDNS_SIGN_RSASHA1        = LDNS_RSASHA1,
#if LDNS_BUILD_CONFIG_USE_DSA
        LDNS_SIGN_DSA            = LDNS_DSA,
#endif /* LDNS_BUILD_CONFIG_USE_DSA */
        LDNS_SIGN_RSASHA1_NSEC3  = LDNS_RSASHA1_NSEC3,
        LDNS_SIGN_RSASHA256      = LDNS_RSASHA256,
        LDNS_SIGN_RSASHA512      = LDNS_RSASHA512,
#if LDNS_BUILD_CONFIG_USE_DSA
        LDNS_SIGN_DSA_NSEC3      = LDNS_DSA_NSEC3,
#endif /* LDNS_BUILD_CONFIG_USE_DSA */
        LDNS_SIGN_ECC_GOST       = LDNS_ECC_GOST,
        LDNS_SIGN_ECDSAP256SHA256 = LDNS_ECDSAP256SHA256,
        LDNS_SIGN_ECDSAP384SHA384 = LDNS_ECDSAP384SHA384,
#if LDNS_BUILD_CONFIG_USE_ED25519
        LDNS_SIGN_ED25519        = LDNS_ED25519,
#endif /* LDNS_BUILD_CONFIG_USE_ED25519 */
#if LDNS_BUILD_CONFIG_USE_ED448
        LDNS_SIGN_ED448          = LDNS_ED448,
#endif /* LDNS_BUILD_CONFIG_USE_ED448 */
        LDNS_SIGN_HMACMD5        = 157, /* not official! This type is for TSIG, not DNSSEC */
        LDNS_SIGN_HMACSHA1       = 158, /* not official! This type is for TSIG, not DNSSEC */
        LDNS_SIGN_HMACSHA256 = 159,  /* ditto */
        LDNS_SIGN_HMACSHA224 = 162,  /* ditto */
        LDNS_SIGN_HMACSHA384 = 164,  /* ditto */
        LDNS_SIGN_HMACSHA512 = 165  /* ditto */
};
typedef enum ldns_enum_signing_algorithm ldns_signing_algorithm;
 
struct ldns_struct_key {
        ldns_signing_algorithm _alg;
        bool _use;
        /* TODO remove unions? */
        struct {
#if LDNS_BUILD_CONFIG_HAVE_SSL
#ifndef S_SPLINT_S
                /* The key can be an OpenSSL EVP Key
                 */
                EVP_PKEY *key;
#endif
#endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
                struct {
                        unsigned char *key;
                        size_t size;
                } hmac;
                void *external_key;
        } _key;
        union {
                struct {
                        uint32_t orig_ttl;
                        uint32_t inception;
                        uint32_t expiration;
                        uint16_t keytag;
                        uint16_t flags;
                }  dnssec;
        } _extra;
        ldns_rdf *_pubkey_owner;
};
typedef struct ldns_struct_key ldns_key;
 
struct ldns_struct_key_list
{
        size_t _key_count;
        ldns_key **_keys;
};
typedef struct ldns_struct_key_list ldns_key_list;
 
 
ldns_key_list *ldns_key_list_new(void);
 
ldns_key *ldns_key_new(void);
 
ldns_key *ldns_key_new_frm_algorithm(ldns_signing_algorithm a, uint16_t size);
 
ldns_status ldns_key_new_frm_fp(ldns_key **k, FILE *fp);
 
ldns_status ldns_key_new_frm_fp_l(ldns_key **k, FILE *fp, int *line_nr);
 
#if LDNS_BUILD_CONFIG_HAVE_SSL
ldns_status ldns_key_new_frm_engine(ldns_key **key, ENGINE *e, char *key_id, ldns_algorithm);
 
 
RSA *ldns_key_new_frm_fp_rsa(FILE *fp);
 
RSA *ldns_key_new_frm_fp_rsa_l(FILE *fp, int *line_nr);
 
 
# if LDNS_BUILD_CONFIG_USE_DSA
DSA *ldns_key_new_frm_fp_dsa(FILE *fp);
 
DSA *ldns_key_new_frm_fp_dsa_l(FILE *fp, int *line_nr);
# endif /* LDNS_BUILD_CONFIG_USE_DSA */
 
unsigned char *ldns_key_new_frm_fp_hmac(FILE *fp, size_t *hmac_size);
 
unsigned char *ldns_key_new_frm_fp_hmac_l(FILE *fp, int *line_nr, size_t *hmac_size);
#endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
 
/* access write functions */
void ldns_key_set_algorithm(ldns_key *k, ldns_signing_algorithm l);
 
#if LDNS_BUILD_CONFIG_HAVE_SSL
void ldns_key_set_evp_key(ldns_key *k, EVP_PKEY *e);
 
void ldns_key_set_rsa_key(ldns_key *k, RSA *r);
 
# if LDNS_BUILD_CONFIG_USE_DSA
void ldns_key_set_dsa_key(ldns_key *k, DSA *d);
# endif /* LDNS_BUILD_CONFIG_USE_DSA */
 
void ldns_key_assign_rsa_key(ldns_key *k, RSA *r);
 
# if LDNS_BUILD_CONFIG_USE_DSA
void ldns_key_assign_dsa_key(ldns_key *k, DSA *d);
# endif /* LDNS_BUILD_CONFIG_USE_DSA */
 
int ldns_key_EVP_load_gost_id(void);
 
void ldns_key_EVP_unload_gost(void);
#endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
 
void ldns_key_set_hmac_key(ldns_key *k, unsigned char *hmac);
 
void ldns_key_set_external_key(ldns_key *key, void *external_key);
 
void ldns_key_set_hmac_size(ldns_key *k, size_t hmac_size);
void ldns_key_set_origttl(ldns_key *k, uint32_t t);
void ldns_key_set_inception(ldns_key *k, uint32_t i);
void ldns_key_set_expiration(ldns_key *k, uint32_t e);
void ldns_key_set_pubkey_owner(ldns_key *k, ldns_rdf *r);
void ldns_key_set_keytag(ldns_key *k, uint16_t tag);
void ldns_key_set_flags(ldns_key *k, uint16_t flags);
void ldns_key_list_set_key_count(ldns_key_list *key, size_t count);
 
bool ldns_key_list_push_key(ldns_key_list *key_list, ldns_key *key);
 
size_t ldns_key_list_key_count(const ldns_key_list *key_list);
 
ldns_key *ldns_key_list_key(const ldns_key_list *key, size_t nr);
 
#if LDNS_BUILD_CONFIG_HAVE_SSL
RSA *ldns_key_rsa_key(const ldns_key *k);
EVP_PKEY *ldns_key_evp_key(const ldns_key *k);
 
# if LDNS_BUILD_CONFIG_USE_DSA
DSA *ldns_key_dsa_key(const ldns_key *k);
# endif /* LDNS_BUILD_CONFIG_USE_DSA */
#endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
 
ldns_signing_algorithm ldns_key_algorithm(const ldns_key *k);
void ldns_key_set_use(ldns_key *k, bool v);
bool ldns_key_use(const ldns_key *k);
unsigned char *ldns_key_hmac_key(const ldns_key *k);
void *ldns_key_external_key(const ldns_key *k);
size_t ldns_key_hmac_size(const ldns_key *k);
uint32_t ldns_key_origttl(const ldns_key *k);
uint32_t ldns_key_inception(const ldns_key *k);
uint32_t ldns_key_expiration(const ldns_key *k);
uint16_t ldns_key_keytag(const ldns_key *k);
ldns_rdf *ldns_key_pubkey_owner(const ldns_key *k);
void
ldns_key_list_set_use(ldns_key_list *keys, bool v);
 
uint16_t ldns_key_flags(const ldns_key *k);
 
ldns_key *ldns_key_list_pop_key(ldns_key_list *key_list);
 
ldns_rr *ldns_key2rr(const ldns_key *k);
 
void ldns_key_print(FILE *output, const ldns_key *k);
 
void ldns_key_free(ldns_key *key);
 
void ldns_key_deep_free(ldns_key *key);
 
void ldns_key_list_free(ldns_key_list *key_list);
 
ldns_rr * ldns_read_anchor_file(const char *filename);
 
char *ldns_key_get_file_base_name(const ldns_key *key);
 
int ldns_key_algo_supported(int algo);
 
ldns_signing_algorithm ldns_get_signing_algorithm_by_name(const char* name);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LDNS_KEYS_H */