Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / include / isc / dst.h
blob66efb6885481a83b8a36be0b9b024636022883f6
1 /* $NetBSD: dst.h,v 1.1.1.1 2009/04/12 15:33:33 christos Exp $ */
3 #ifndef DST_H
4 #define DST_H
6 #ifndef HAS_DST_KEY
7 typedef struct dst_key {
8 char *dk_key_name; /*%< name of the key */
9 int dk_key_size; /*%< this is the size of the key in bits */
10 int dk_proto; /*%< what protocols this key can be used for */
11 int dk_alg; /*%< algorithm number from key record */
12 u_int32_t dk_flags; /*%< and the flags of the public key */
13 u_int16_t dk_id; /*%< identifier of the key */
14 } DST_KEY;
15 #endif /* HAS_DST_KEY */
17 * do not taint namespace
19 #define dst_bsafe_init __dst_bsafe_init
20 #define dst_buffer_to_key __dst_buffer_to_key
21 #define dst_check_algorithm __dst_check_algorithm
22 #define dst_compare_keys __dst_compare_keys
23 #define dst_cylink_init __dst_cylink_init
24 #define dst_dnskey_to_key __dst_dnskey_to_key
25 #define dst_eay_dss_init __dst_eay_dss_init
26 #define dst_free_key __dst_free_key
27 #define dst_generate_key __dst_generate_key
28 #define dst_hmac_md5_init __dst_hmac_md5_init
29 #define dst_init __dst_init
30 #define dst_key_to_buffer __dst_key_to_buffer
31 #define dst_key_to_dnskey __dst_key_to_dnskey
32 #define dst_read_key __dst_read_key
33 #define dst_rsaref_init __dst_rsaref_init
34 #define dst_s_build_filename __dst_s_build_filename
35 #define dst_s_calculate_bits __dst_s_calculate_bits
36 #define dst_s_conv_bignum_b64_to_u8 __dst_s_conv_bignum_b64_to_u8
37 #define dst_s_conv_bignum_u8_to_b64 __dst_s_conv_bignum_u8_to_b64
38 #define dst_s_dns_key_id __dst_s_dns_key_id
39 #define dst_s_dump __dst_s_dump
40 #define dst_s_filename_length __dst_s_filename_length
41 #define dst_s_fopen __dst_s_fopen
42 #define dst_s_get_int16 __dst_s_get_int16
43 #define dst_s_get_int32 __dst_s_get_int32
44 #define dst_s_id_calc __dst_s_id_calc
45 #define dst_s_put_int16 __dst_s_put_int16
46 #define dst_s_put_int32 __dst_s_put_int32
47 #define dst_s_quick_random __dst_s_quick_random
48 #define dst_s_quick_random_set __dst_s_quick_random_set
49 #define dst_s_random __dst_s_random
50 #define dst_s_semi_random __dst_s_semi_random
51 #define dst_s_verify_str __dst_s_verify_str
52 #define dst_sig_size __dst_sig_size
53 #define dst_sign_data __dst_sign_data
54 #define dst_verify_data __dst_verify_data
55 #define dst_write_key __dst_write_key
57 /*
58 * DST Crypto API defintions
60 void dst_init(void);
61 int dst_check_algorithm(const int);
64 int dst_sign_data(const int, /*!< specifies INIT/UPDATE/FINAL/ALL */
65 DST_KEY *, /*!< the key to use */
66 void **, /*!< pointer to state structure */
67 const u_char *, /*!< data to be signed */
68 const int, /*!< length of input data */
69 u_char *, /*!< buffer to write signature to */
70 const int); /*!< size of output buffer */
71 int dst_verify_data(const int, /*!< specifies INIT/UPDATE/FINAL/ALL */
72 DST_KEY *, /*!< the key to use */
73 void **, /*!< pointer to state structure */
74 const u_char *, /*!< data to be verified */
75 const int, /*!< length of input data */
76 const u_char *, /*!< buffer containing signature */
77 const int); /*!< length of signature */
78 DST_KEY *dst_read_key(const char *, /*!< name of key */
79 const u_int16_t, /*!< key tag identifier */
80 const int, /*!< key algorithm */
81 const int); /*!< Private/PublicKey wanted */
82 int dst_write_key(const DST_KEY *, /*!< key to write out */
83 const int); /*!< Public/Private */
84 DST_KEY *dst_dnskey_to_key(const char *, /*!< KEY record name */
85 const u_char *, /*!< KEY RDATA */
86 const int); /*!< size of input buffer */
87 int dst_key_to_dnskey(const DST_KEY *, /*!< key to translate */
88 u_char *, /*!< output buffer */
89 const int); /*!< size of out_storage */
90 DST_KEY *dst_buffer_to_key(const char *, /*!< name of the key */
91 const int, /*!< algorithm */
92 const int, /*!< dns flags */
93 const int, /*!< dns protocol */
94 const u_char *, /*!< key in dns wire fmt */
95 const int); /*!< size of key */
96 int dst_key_to_buffer(DST_KEY *, u_char *, int);
98 DST_KEY *dst_generate_key(const char *, /*!< name of new key */
99 const int, /*!< key algorithm to generate */
100 const int, /*!< size of new key */
101 const int, /*!< alg dependent parameter */
102 const int, /*!< key DNS flags */
103 const int); /*!< key DNS protocol */
104 DST_KEY *dst_free_key(DST_KEY *);
105 int dst_compare_keys(const DST_KEY *, const DST_KEY *);
107 int dst_sig_size(DST_KEY *);
110 /* support for dns key tags/ids */
111 u_int16_t dst_s_dns_key_id(const u_char *, const int);
112 u_int16_t dst_s_id_calc(const u_char *, const int);
114 /* Used by callers as well as by the library. */
115 #define RAW_KEY_SIZE 8192 /*%< large enough to store any key */
116 /* DST_API control flags */
117 /* These are used used in functions dst_sign_data and dst_verify_data */
118 #define SIG_MODE_INIT 1 /*%< initialize digest */
119 #define SIG_MODE_UPDATE 2 /*%< add data to digest */
120 #define SIG_MODE_FINAL 4 /*%< generate/verify signature */
121 #define SIG_MODE_ALL (SIG_MODE_INIT|SIG_MODE_UPDATE|SIG_MODE_FINAL)
123 /* Flags for dst_read_private_key() */
124 #define DST_FORCE_READ 0x1000000
125 #define DST_CAN_SIGN 0x010F
126 #define DST_NO_AUTHEN 0x8000
127 #define DST_EXTEND_FLAG 0x1000
128 #define DST_STANDARD 0
129 #define DST_PRIVATE 0x2000000
130 #define DST_PUBLIC 0x4000000
131 #define DST_RAND_SEMI 1
132 #define DST_RAND_STD 2
133 #define DST_RAND_KEY 3
134 #define DST_RAND_DSS 4
137 /* DST algorithm codes */
138 #define KEY_RSA 1
139 #define KEY_DH 2
140 #define KEY_DSA 3
141 #define KEY_PRIVATE 254
142 #define KEY_EXPAND 255
143 #define KEY_HMAC_MD5 157
144 #define KEY_HMAC_SHA1 158
145 #define UNKNOWN_KEYALG 0
146 #define DST_MAX_ALGS KEY_HMAC_SHA1
148 /* DST constants to locations in KEY record changes in new KEY record */
149 #define DST_FLAGS_SIZE 2
150 #define DST_KEY_PROT 2
151 #define DST_KEY_ALG 3
152 #define DST_EXT_FLAG 4
153 #define DST_KEY_START 4
155 #ifndef SIGN_F_NOKEY
156 #define SIGN_F_NOKEY 0xC000
157 #endif
159 /* error codes from dst routines */
160 #define SIGN_INIT_FAILURE (-23)
161 #define SIGN_UPDATE_FAILURE (-24)
162 #define SIGN_FINAL_FAILURE (-25)
163 #define VERIFY_INIT_FAILURE (-26)
164 #define VERIFY_UPDATE_FAILURE (-27)
165 #define VERIFY_FINAL_FAILURE (-28)
166 #define MISSING_KEY_OR_SIGNATURE (-30)
167 #define UNSUPPORTED_KEYALG (-31)
169 #endif /* DST_H */
170 /*! \file */