keys.h
Go to the documentation of this file.
00001 /*
00002  * 
00003  * keys.h
00004  *
00005  * priv key definitions
00006  *
00007  * a Net::DNS like library for C
00008  *
00009  * (c) NLnet Labs, 2005-2006
00010  *
00011  * See the file LICENSE for the license
00012  */
00013 
00021 #ifndef LDNS_KEYS_H
00022 #define LDNS_KEYS_H
00023 
00024 #include <ldns/common.h>
00025 #if LDNS_BUILD_CONFIG_HAVE_SSL
00026 #include <openssl/ssl.h>
00027 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00028 #include <ldns/dnssec.h>
00029 #include <ldns/util.h>
00030 #include <errno.h>
00031 
00032 #ifdef __cplusplus
00033 extern "C" {
00034 #endif
00035 
00036 extern ldns_lookup_table ldns_signing_algorithms[];
00037 
00038 #define LDNS_KEY_ZONE_KEY 0x0100   /* rfc 4034 */
00039 #define LDNS_KEY_SEP_KEY 0x0001    /* rfc 4034 */
00040 #define LDNS_KEY_REVOKE_KEY 0x0080 /* rfc 5011 */
00041 
00045 enum ldns_enum_algorithm
00046 {
00047         LDNS_RSAMD5             = 1,   /* RFC 4034,4035 */
00048         LDNS_DH                 = 2,
00049         LDNS_DSA                = 3,
00050         LDNS_ECC                = 4,
00051         LDNS_RSASHA1            = 5,
00052         LDNS_DSA_NSEC3          = 6,
00053         LDNS_RSASHA1_NSEC3      = 7,
00054         LDNS_RSASHA256          = 8,   /* RFC 5702 */
00055         LDNS_RSASHA512          = 10,  /* RFC 5702 */
00056         LDNS_ECC_GOST           = 12,  /* RFC 5933 */
00057         LDNS_ECDSAP256SHA256    = 13,  /* RFC 6605 */
00058         LDNS_ECDSAP384SHA384    = 14,  /* RFC 6605 */
00059         LDNS_INDIRECT           = 252,
00060         LDNS_PRIVATEDNS         = 253,
00061         LDNS_PRIVATEOID         = 254
00062 };
00063 typedef enum ldns_enum_algorithm ldns_algorithm;
00064 
00068 enum ldns_enum_hash
00069 {
00070         LDNS_SHA1               = 1,  /* RFC 4034 */
00071         LDNS_SHA256             = 2,  /* RFC 4509 */
00072         LDNS_HASH_GOST          = 3,  /* RFC 5933 */
00073         LDNS_SHA384             = 4   /* RFC 6605 */
00074 };
00075 typedef enum ldns_enum_hash ldns_hash;
00076 
00080 enum ldns_enum_signing_algorithm
00081 {
00082         LDNS_SIGN_RSAMD5         = LDNS_RSAMD5,
00083         LDNS_SIGN_RSASHA1        = LDNS_RSASHA1,
00084         LDNS_SIGN_DSA            = LDNS_DSA,
00085         LDNS_SIGN_RSASHA1_NSEC3  = LDNS_RSASHA1_NSEC3,
00086         LDNS_SIGN_RSASHA256      = LDNS_RSASHA256,
00087         LDNS_SIGN_RSASHA512      = LDNS_RSASHA512,
00088         LDNS_SIGN_DSA_NSEC3      = LDNS_DSA_NSEC3,
00089         LDNS_SIGN_ECC_GOST       = LDNS_ECC_GOST,
00090         LDNS_SIGN_ECDSAP256SHA256 = LDNS_ECDSAP256SHA256,
00091         LDNS_SIGN_ECDSAP384SHA384 = LDNS_ECDSAP384SHA384,
00092         LDNS_SIGN_HMACMD5        = 157, /* not official! This type is for TSIG, not DNSSEC */
00093         LDNS_SIGN_HMACSHA1       = 158, /* not official! This type is for TSIG, not DNSSEC */
00094         LDNS_SIGN_HMACSHA256 = 159  /* ditto */
00095 };
00096 typedef enum ldns_enum_signing_algorithm ldns_signing_algorithm;
00097 
00108 struct ldns_struct_key {
00109         ldns_signing_algorithm _alg;
00111         bool _use;
00113         /* TODO remove unions? */
00114         struct {
00115 #if LDNS_BUILD_CONFIG_HAVE_SSL
00116 #ifndef S_SPLINT_S
00117                 /* The key can be an OpenSSL EVP Key
00118                  */
00119                 EVP_PKEY *key;
00120 #endif
00121 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00122 
00125                 struct {
00126                         unsigned char *key;
00127                         size_t size;
00128                 } hmac;
00132                 void *external_key;
00133         } _key;
00135         union {
00137                 struct {
00139                         uint32_t orig_ttl;
00141                         uint32_t inception;
00143                         uint32_t expiration;
00145                         uint16_t keytag;
00147                         uint16_t flags;
00148                 }  dnssec;
00149         } _extra;
00151         ldns_rdf *_pubkey_owner;
00152 };
00153 typedef struct ldns_struct_key ldns_key;
00154 
00158 struct ldns_struct_key_list
00159 {
00160         size_t _key_count;
00161         ldns_key **_keys;
00162 };
00163 typedef struct ldns_struct_key_list ldns_key_list;
00164 
00165 
00170 ldns_key_list *ldns_key_list_new();
00171 
00176 ldns_key *ldns_key_new();
00177 
00185 ldns_key *ldns_key_new_frm_algorithm(ldns_signing_algorithm a, uint16_t size);
00186 
00197 ldns_status ldns_key_new_frm_fp(ldns_key **k, FILE *fp);
00198 
00210 ldns_status ldns_key_new_frm_fp_l(ldns_key **k, FILE *fp, int *line_nr);
00211 
00212 #if LDNS_BUILD_CONFIG_HAVE_SSL
00213 
00217 ldns_status ldns_key_new_frm_engine(ldns_key **key, ENGINE *e, char *key_id, ldns_algorithm);
00218 
00219 
00226 RSA *ldns_key_new_frm_fp_rsa(FILE *fp);
00227 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00228 
00229 #if LDNS_BUILD_CONFIG_HAVE_SSL
00230 
00237 RSA *ldns_key_new_frm_fp_rsa_l(FILE *fp, int *line_nr);
00238 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00239 
00240 #if LDNS_BUILD_CONFIG_HAVE_SSL
00241 
00247 DSA *ldns_key_new_frm_fp_dsa(FILE *fp);
00248 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00249 
00250 #if LDNS_BUILD_CONFIG_HAVE_SSL
00251 
00258 DSA *ldns_key_new_frm_fp_dsa_l(FILE *fp, int *line_nr);
00259 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00260 
00261 #if LDNS_BUILD_CONFIG_HAVE_SSL
00262 
00270 unsigned char *ldns_key_new_frm_fp_hmac(FILE *fp, size_t *hmac_size);
00271 #endif
00272 
00273 #if LDNS_BUILD_CONFIG_HAVE_SSL
00274 
00283 unsigned char *ldns_key_new_frm_fp_hmac_l(FILE *fp, int *line_nr, size_t *hmac_size);
00284 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00285 
00286 /* acces write functions */
00292 void ldns_key_set_algorithm(ldns_key *k, ldns_signing_algorithm l);
00293 #if LDNS_BUILD_CONFIG_HAVE_SSL
00294 
00299 void ldns_key_set_evp_key(ldns_key *k, EVP_PKEY *e);
00300 
00306 void ldns_key_set_rsa_key(ldns_key *k, RSA *r);
00312 void ldns_key_set_dsa_key(ldns_key *k, DSA *d);
00313 
00319 int ldns_key_EVP_load_gost_id(void);
00320 
00322 void ldns_key_EVP_unload_gost(void);
00323 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00324 
00330 void ldns_key_set_hmac_key(ldns_key *k, unsigned char *hmac);
00331 
00342 void ldns_key_set_external_key(ldns_key *key, void *external_key);
00343 
00349 void ldns_key_set_hmac_size(ldns_key *k, size_t hmac_size);
00355 void ldns_key_set_origttl(ldns_key *k, uint32_t t);
00361 void ldns_key_set_inception(ldns_key *k, uint32_t i);
00367 void ldns_key_set_expiration(ldns_key *k, uint32_t e);
00373 void ldns_key_set_pubkey_owner(ldns_key *k, ldns_rdf *r);
00379 void ldns_key_set_keytag(ldns_key *k, uint16_t tag);
00385 void ldns_key_set_flags(ldns_key *k, uint16_t flags);
00391 void ldns_key_list_set_key_count(ldns_key_list *key, size_t count);
00392 
00399 bool ldns_key_list_push_key(ldns_key_list *key_list, ldns_key *key);
00400 
00406 size_t ldns_key_list_key_count(const ldns_key_list *key_list);
00407 
00414 ldns_key *ldns_key_list_key(const ldns_key_list *key, size_t nr);
00415 
00416 #if LDNS_BUILD_CONFIG_HAVE_SSL
00417 
00422 RSA *ldns_key_rsa_key(const ldns_key *k);
00428 EVP_PKEY *ldns_key_evp_key(const ldns_key *k);
00429 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00430 
00434 #if LDNS_BUILD_CONFIG_HAVE_SSL
00435 DSA *ldns_key_dsa_key(const ldns_key *k);
00436 #endif /* LDNS_BUILD_CONFIG_HAVE_SSL */
00437 
00443 ldns_signing_algorithm ldns_key_algorithm(const ldns_key *k);
00449 void ldns_key_set_use(ldns_key *k, bool v);
00455 bool ldns_key_use(const ldns_key *k);
00461 unsigned char *ldns_key_hmac_key(const ldns_key *k);
00467 void *ldns_key_external_key(const ldns_key *k);
00473 size_t ldns_key_hmac_size(const ldns_key *k);
00479 uint32_t ldns_key_origttl(const ldns_key *k);
00485 uint32_t ldns_key_inception(const ldns_key *k);
00491 uint32_t ldns_key_expiration(const ldns_key *k);
00497 uint16_t ldns_key_keytag(const ldns_key *k);
00503 ldns_rdf *ldns_key_pubkey_owner(const ldns_key *k);
00509 void
00510 ldns_key_list_set_use(ldns_key_list *keys, bool v);
00511 
00517 uint16_t ldns_key_flags(const ldns_key *k);
00518 
00524 ldns_key *ldns_key_list_pop_key(ldns_key_list *key_list);
00525 
00535 ldns_rr *ldns_key2rr(const ldns_key *k);
00536 
00543 void ldns_key_print(FILE *output, const ldns_key *k);
00544 
00550 void ldns_key_free(ldns_key *key);
00551 
00558 void ldns_key_deep_free(ldns_key *key);
00559 
00564 void ldns_key_list_free(ldns_key_list *key_list);
00565 
00571 ldns_rr * ldns_read_anchor_file(const char *filename);
00572 
00583 char *ldns_key_get_file_base_name(ldns_key *key);
00584 
00590 int ldns_key_algo_supported(int algo);
00591 
00597 ldns_signing_algorithm ldns_get_signing_algorithm_by_name(const char* name);
00598 
00599 #ifdef __cplusplus
00600 }
00601 #endif
00602 
00603 #endif /* LDNS_KEYS_H */