1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 * 25 * 26 * Constant definitions and function prototypes for the KMF library. 27 * Commonly used data types are defined in "kmftypes.h". 28 */ 29 30 #ifndef _KMFAPI_H 31 #define _KMFAPI_H 32 33 #pragma ident "%Z%%M% %I% %E% SMI" 34 35 #include <kmftypes.h> 36 #include <security/cryptoki.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * Setup operations. 44 */ 45 extern KMF_RETURN kmf_initialize(KMF_HANDLE_T *, char *, char *); 46 extern KMF_RETURN kmf_configure_keystore(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 47 extern KMF_RETURN kmf_finalize(KMF_HANDLE_T); 48 49 /* 50 * Key operations. 51 */ 52 extern KMF_RETURN kmf_create_keypair(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 53 54 extern KMF_RETURN kmf_delete_key_from_keystore(KMF_HANDLE_T, int, 55 KMF_ATTRIBUTE *); 56 57 extern KMF_RETURN kmf_find_key(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 58 59 extern KMF_RETURN kmf_find_prikey_by_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 60 61 extern KMF_RETURN kmf_store_key(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 62 63 extern KMF_RETURN kmf_create_sym_key(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 64 65 extern KMF_RETURN kmf_get_sym_key_value(KMF_HANDLE_T, KMF_KEY_HANDLE *, 66 KMF_RAW_SYM_KEY *); 67 68 /* 69 * Certificate operations. 70 */ 71 extern KMF_RETURN kmf_find_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 72 73 extern KMF_RETURN kmf_encode_cert_record(KMF_X509_CERTIFICATE *, KMF_DATA *); 74 75 extern KMF_RETURN kmf_import_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 76 77 extern KMF_RETURN kmf_store_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 78 79 extern KMF_RETURN kmf_delete_cert_from_keystore(KMF_HANDLE_T, int, 80 KMF_ATTRIBUTE *); 81 82 extern KMF_RETURN kmf_validate_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 83 84 extern KMF_RETURN kmf_create_cert_file(const KMF_DATA *, KMF_ENCODE_FORMAT, 85 char *); 86 87 extern KMF_RETURN kmf_download_cert(KMF_HANDLE_T, char *, char *, int, 88 unsigned int, char *, KMF_ENCODE_FORMAT *); 89 90 extern KMF_RETURN kmf_is_cert_file(KMF_HANDLE_T, char *, KMF_ENCODE_FORMAT *); 91 92 extern KMF_RETURN kmf_check_cert_date(KMF_HANDLE_T, const KMF_DATA *); 93 94 /* 95 * Crypto operations with key or cert. 96 */ 97 extern KMF_RETURN kmf_encrypt(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 98 extern KMF_RETURN kmf_decrypt(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 99 extern KMF_RETURN kmf_sign_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 100 extern KMF_RETURN kmf_sign_data(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 101 extern KMF_RETURN kmf_verify_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 102 extern KMF_RETURN kmf_verify_data(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 103 104 /* 105 * CRL operations. 106 */ 107 extern KMF_RETURN kmf_import_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 108 extern KMF_RETURN kmf_delete_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 109 extern KMF_RETURN kmf_list_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 110 extern KMF_RETURN kmf_find_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 111 extern KMF_RETURN kmf_find_cert_in_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 112 extern KMF_RETURN kmf_verify_crl_file(KMF_HANDLE_T, char *, KMF_DATA *); 113 extern KMF_RETURN kmf_check_crl_date(KMF_HANDLE_T, char *); 114 extern KMF_RETURN kmf_download_crl(KMF_HANDLE_T, char *, char *, 115 int, unsigned int, char *, KMF_ENCODE_FORMAT *); 116 extern KMF_RETURN kmf_is_crl_file(KMF_HANDLE_T, char *, KMF_ENCODE_FORMAT *); 117 118 /* 119 * CSR operations. 120 */ 121 extern KMF_RETURN kmf_create_csr_file(KMF_DATA *, KMF_ENCODE_FORMAT, char *); 122 extern KMF_RETURN kmf_set_csr_pubkey(KMF_HANDLE_T, 123 KMF_KEY_HANDLE *, KMF_CSR_DATA *); 124 extern KMF_RETURN kmf_set_csr_version(KMF_CSR_DATA *, uint32_t); 125 extern KMF_RETURN kmf_set_csr_subject(KMF_CSR_DATA *, KMF_X509_NAME *); 126 extern KMF_RETURN kmf_set_csr_extn(KMF_CSR_DATA *, KMF_X509_EXTENSION *); 127 extern KMF_RETURN kmf_set_csr_sig_alg(KMF_CSR_DATA *, KMF_ALGORITHM_INDEX); 128 extern KMF_RETURN kmf_set_csr_subject_altname(KMF_CSR_DATA *, char *, 129 int, KMF_GENERALNAMECHOICES); 130 extern KMF_RETURN kmf_set_csr_ku(KMF_CSR_DATA *, int, uint16_t); 131 extern KMF_RETURN kmf_sign_csr(KMF_HANDLE_T, const KMF_CSR_DATA *, 132 KMF_KEY_HANDLE *, KMF_DATA *); 133 134 /* 135 * GetCert operations. 136 */ 137 extern KMF_RETURN kmf_get_cert_extn(const KMF_DATA *, KMF_OID *, 138 KMF_X509_EXTENSION *); 139 140 extern KMF_RETURN kmf_get_cert_extns(const KMF_DATA *, KMF_FLAG_CERT_EXTN, 141 KMF_X509_EXTENSION **, int *); 142 143 extern KMF_RETURN kmf_get_cert_ku(const KMF_DATA *, KMF_X509EXT_KEY_USAGE *); 144 145 extern KMF_RETURN kmf_get_cert_eku(const KMF_DATA *, KMF_X509EXT_EKU *); 146 147 extern KMF_RETURN kmf_get_cert_basic_constraint(const KMF_DATA *, 148 KMF_BOOL *, KMF_X509EXT_BASICCONSTRAINTS *); 149 150 extern KMF_RETURN kmf_get_cert_policies(const KMF_DATA *, 151 KMF_BOOL *, KMF_X509EXT_CERT_POLICIES *); 152 153 extern KMF_RETURN kmf_get_cert_auth_info_access(const KMF_DATA *, 154 KMF_X509EXT_AUTHINFOACCESS *); 155 156 extern KMF_RETURN kmf_get_cert_crl_dist_pts(const KMF_DATA *, 157 KMF_X509EXT_CRLDISTPOINTS *); 158 159 extern KMF_RETURN kmf_get_cert_version_str(KMF_HANDLE_T, const KMF_DATA *, 160 char **); 161 162 extern KMF_RETURN kmf_get_cert_subject_str(KMF_HANDLE_T, const KMF_DATA *, 163 char **); 164 165 extern KMF_RETURN kmf_get_cert_issuer_str(KMF_HANDLE_T, const KMF_DATA *, 166 char **); 167 168 extern KMF_RETURN kmf_get_cert_serial_str(KMF_HANDLE_T, const KMF_DATA *, 169 char **); 170 171 extern KMF_RETURN kmf_get_cert_start_date_str(KMF_HANDLE_T, const KMF_DATA *, 172 char **); 173 174 extern KMF_RETURN kmf_get_cert_end_date_str(KMF_HANDLE_T, const KMF_DATA *, 175 char **); 176 177 extern KMF_RETURN kmf_get_cert_pubkey_alg_str(KMF_HANDLE_T, const KMF_DATA *, 178 char **); 179 180 extern KMF_RETURN kmf_get_cert_sig_alg_str(KMF_HANDLE_T, const KMF_DATA *, 181 char **); 182 183 extern KMF_RETURN kmf_get_cert_pubkey_str(KMF_HANDLE_T, const KMF_DATA *, 184 char **); 185 186 extern KMF_RETURN kmf_get_cert_email_str(KMF_HANDLE_T, const KMF_DATA *, 187 char **); 188 189 extern KMF_RETURN kmf_get_cert_extn_str(KMF_HANDLE_T, const KMF_DATA *, 190 KMF_PRINTABLE_ITEM, char **); 191 192 extern KMF_RETURN kmf_get_cert_id_data(const KMF_DATA *, KMF_DATA *); 193 194 extern KMF_RETURN kmf_get_cert_id_str(const KMF_DATA *, char **); 195 196 extern KMF_RETURN kmf_get_cert_validity(const KMF_DATA *, time_t *, time_t *); 197 198 199 /* 200 * SetCert operations 201 */ 202 extern KMF_RETURN kmf_set_cert_pubkey(KMF_HANDLE_T, KMF_KEY_HANDLE *, 203 KMF_X509_CERTIFICATE *); 204 205 extern KMF_RETURN kmf_set_cert_subject(KMF_X509_CERTIFICATE *, 206 KMF_X509_NAME *); 207 208 extern KMF_RETURN kmf_set_cert_ku(KMF_X509_CERTIFICATE *, int, uint16_t); 209 210 extern KMF_RETURN kmf_set_cert_issuer(KMF_X509_CERTIFICATE *, 211 KMF_X509_NAME *); 212 213 extern KMF_RETURN kmf_set_cert_sig_alg(KMF_X509_CERTIFICATE *, 214 KMF_ALGORITHM_INDEX); 215 216 extern KMF_RETURN kmf_set_cert_validity(KMF_X509_CERTIFICATE *, 217 time_t, uint32_t); 218 219 extern KMF_RETURN kmf_set_cert_serial(KMF_X509_CERTIFICATE *, 220 KMF_BIGINT *); 221 222 extern KMF_RETURN kmf_set_cert_version(KMF_X509_CERTIFICATE *, uint32_t); 223 224 extern KMF_RETURN kmf_set_cert_issuer_altname(KMF_X509_CERTIFICATE *, 225 int, KMF_GENERALNAMECHOICES, char *); 226 227 extern KMF_RETURN kmf_set_cert_subject_altname(KMF_X509_CERTIFICATE *, 228 int, KMF_GENERALNAMECHOICES, char *); 229 230 extern KMF_RETURN kmf_add_cert_eku(KMF_X509_CERTIFICATE *, KMF_OID *, int); 231 232 extern KMF_RETURN kmf_set_cert_extn(KMF_X509_CERTIFICATE *, 233 KMF_X509_EXTENSION *); 234 235 extern KMF_RETURN kmf_set_cert_basic_constraint(KMF_X509_CERTIFICATE *, 236 KMF_BOOL, KMF_X509EXT_BASICCONSTRAINTS *); 237 238 239 /* 240 * PK12 operations 241 */ 242 extern KMF_RETURN kmf_export_pk12(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 243 244 extern KMF_RETURN kmf_build_pk12(KMF_HANDLE_T, int, KMF_X509_DER_CERT *, 245 int, KMF_KEY_HANDLE *, KMF_CREDENTIAL *, char *); 246 247 extern KMF_RETURN kmf_import_objects(KMF_HANDLE_T, char *, KMF_CREDENTIAL *, 248 KMF_DATA **, int *, KMF_RAW_KEY_DATA **, int *); 249 250 /* 251 * OCSP operations 252 */ 253 extern KMF_RETURN kmf_get_ocsp_for_cert(KMF_HANDLE_T, KMF_DATA *, KMF_DATA *, 254 KMF_DATA *); 255 256 extern KMF_RETURN kmf_create_ocsp_request(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 257 258 extern KMF_RETURN kmf_get_encoded_ocsp_response(KMF_HANDLE_T, char *, 259 char *, int, char *, int, char *, unsigned int); 260 261 extern KMF_RETURN kmf_get_ocsp_status_for_cert(KMF_HANDLE_T, int, 262 KMF_ATTRIBUTE *); 263 264 /* 265 * Policy Operations 266 */ 267 extern KMF_RETURN kmf_set_policy(KMF_HANDLE_T, char *, char *); 268 269 /* 270 * Error handling. 271 */ 272 extern KMF_RETURN kmf_get_plugin_error_str(KMF_HANDLE_T, char **); 273 extern KMF_RETURN kmf_get_kmf_error_str(KMF_RETURN, char **); 274 275 /* 276 * Miscellaneous 277 */ 278 extern KMF_RETURN kmf_dn_parser(char *, KMF_X509_NAME *); 279 extern KMF_RETURN kmf_read_input_file(KMF_HANDLE_T, char *, KMF_DATA *); 280 extern KMF_RETURN kmf_der_to_pem(KMF_OBJECT_TYPE, unsigned char *, 281 int, unsigned char **, int *); 282 extern KMF_RETURN kmf_pem_to_der(unsigned char *, int, unsigned char **, int *); 283 extern char *kmf_oid_to_string(KMF_OID *); 284 extern KMF_RETURN kmf_string_to_oid(char *, KMF_OID *); 285 extern int kmf_compare_rdns(KMF_X509_NAME *, KMF_X509_NAME *); 286 extern KMF_RETURN kmf_get_file_format(char *, KMF_ENCODE_FORMAT *); 287 extern uint32_t kmf_string_to_ku(char *); 288 extern char *kmf_ku_to_string(uint32_t); 289 extern KMF_RETURN kmf_hexstr_to_bytes(unsigned char *, unsigned char **, 290 size_t *); 291 292 #define KMF_CompareRDNs kmf_compare_rdns 293 294 /* 295 * Memory cleanup operations 296 */ 297 extern void kmf_free_dn(KMF_X509_NAME *); 298 extern void kmf_free_kmf_cert(KMF_HANDLE_T, KMF_X509_DER_CERT *); 299 extern void kmf_free_data(KMF_DATA *); 300 extern void kmf_free_algoid(KMF_X509_ALGORITHM_IDENTIFIER *); 301 extern void kmf_free_extn(KMF_X509_EXTENSION *); 302 extern void kmf_free_tbs_csr(KMF_TBS_CSR *); 303 extern void kmf_free_signed_csr(KMF_CSR_DATA *); 304 extern void kmf_free_tbs_cert(KMF_X509_TBS_CERT *); 305 extern void kmf_free_signed_cert(KMF_X509_CERTIFICATE *); 306 extern void kmf_free_str(char *); 307 extern void kmf_free_eku(KMF_X509EXT_EKU *); 308 extern void kmf_free_spki(KMF_X509_SPKI *); 309 extern void kmf_free_kmf_key(KMF_HANDLE_T, KMF_KEY_HANDLE *); 310 extern void kmf_free_bigint(KMF_BIGINT *); 311 extern void kmf_free_raw_key(KMF_RAW_KEY_DATA *); 312 extern void kmf_free_raw_sym_key(KMF_RAW_SYM_KEY *); 313 extern void kmf_free_crl_dist_pts(KMF_X509EXT_CRLDISTPOINTS *); 314 315 /* APIs for PKCS#11 token */ 316 extern KMF_RETURN kmf_pk11_token_lookup(KMF_HANDLE_T, char *, CK_SLOT_ID *); 317 extern KMF_RETURN kmf_set_token_pin(KMF_HANDLE_T, int, KMF_ATTRIBUTE *); 318 extern CK_SESSION_HANDLE kmf_get_pk11_handle(KMF_HANDLE_T); 319 320 /* 321 * Attribute management routines. 322 */ 323 int kmf_find_attr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int); 324 void *kmf_get_attr_ptr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int); 325 KMF_RETURN kmf_get_attr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int, void *, 326 uint32_t *); 327 KMF_RETURN kmf_get_string_attr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int, char **); 328 KMF_RETURN kmf_set_attr(KMF_ATTRIBUTE *, int, KMF_ATTR_TYPE, void *, uint32_t); 329 void kmf_set_attr_at_index(KMF_ATTRIBUTE *, int, KMF_ATTR_TYPE, 330 void *, uint32_t); 331 332 /* 333 * Legacy support only - do not use these APIs - they can be removed at any 334 * time. 335 */ 336 extern KMF_RETURN KMF_ConfigureKeystore(KMF_HANDLE_T, KMF_CONFIG_PARAMS *); 337 extern KMF_RETURN KMF_CreateCSRFile(KMF_DATA *, KMF_ENCODE_FORMAT, char *); 338 extern KMF_RETURN KMF_CreateKeypair(KMF_HANDLE_T, 339 KMF_CREATEKEYPAIR_PARAMS *, KMF_KEY_HANDLE *, KMF_KEY_HANDLE *); 340 extern KMF_RETURN KMF_DNParser(char *, KMF_X509_NAME *); 341 extern KMF_RETURN KMF_Finalize(KMF_HANDLE_T); 342 extern KMF_RETURN KMF_FindCert(KMF_HANDLE_T, KMF_FINDCERT_PARAMS *, 343 KMF_X509_DER_CERT *, uint32_t *); 344 extern KMF_RETURN KMF_FindKey(KMF_HANDLE_T, KMF_FINDKEY_PARAMS *, 345 KMF_KEY_HANDLE *, uint32_t *); 346 extern void KMF_FreeData(KMF_DATA *); 347 extern void KMF_FreeKMFCert(KMF_HANDLE_T, KMF_X509_DER_CERT *); 348 extern void KMF_FreeKMFKey(KMF_HANDLE_T, KMF_KEY_HANDLE *); 349 extern void KMF_FreeSignedCSR(KMF_CSR_DATA *); 350 extern KMF_RETURN KMF_GetCertIDString(const KMF_DATA *, char **); 351 extern KMF_RETURN KMF_GetCertIssuerNameString(KMF_HANDLE_T, 352 const KMF_DATA *, char **); 353 extern KMF_RETURN KMF_GetCertSubjectNameString(KMF_HANDLE_T, 354 const KMF_DATA *, char **); 355 extern KMF_RETURN KMF_GetKMFErrorString(KMF_RETURN, char **); 356 extern KMF_RETURN KMF_Initialize(KMF_HANDLE_T *, char *, char *); 357 extern KMF_RETURN KMF_ReadInputFile(KMF_HANDLE_T, char *, KMF_DATA *); 358 extern KMF_RETURN KMF_SetCSRPubKey(KMF_HANDLE_T, KMF_KEY_HANDLE *, 359 KMF_CSR_DATA *); 360 extern KMF_RETURN KMF_SetCSRSignatureAlgorithm(KMF_CSR_DATA *, 361 KMF_ALGORITHM_INDEX); 362 extern KMF_RETURN KMF_SetCSRSubjectName(KMF_CSR_DATA *, KMF_X509_NAME *); 363 extern KMF_RETURN KMF_SetCSRVersion(KMF_CSR_DATA *, uint32_t); 364 extern KMF_RETURN KMF_SignCSR(KMF_HANDLE_T, const KMF_CSR_DATA *, 365 KMF_KEY_HANDLE *, KMF_DATA *); 366 extern KMF_RETURN KMF_SignDataWithKey(KMF_HANDLE_T, KMF_KEY_HANDLE *, 367 KMF_OID *, KMF_DATA *, KMF_DATA *); 368 extern KMF_RETURN KMF_VerifyCertWithCert(KMF_HANDLE_T, const KMF_DATA *, 369 const KMF_DATA *); 370 extern KMF_RETURN KMF_VerifyDataWithCert(KMF_HANDLE_T, 371 KMF_KEYSTORE_TYPE, KMF_ALGORITHM_INDEX, KMF_DATA *, KMF_DATA *, 372 const KMF_DATA *); 373 374 #ifdef __cplusplus 375 } 376 #endif 377 #endif /* _KMFAPI_H */ 378