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