2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License (the "License").
2N/A * You may not use this file except in compliance with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A *
2N/A * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
2N/A *
2N/A * Constant definitions and function prototypes for the KMF library.
2N/A * Commonly used data types are defined in "kmftypes.h".
2N/A */
2N/A
2N/A#ifndef _KMFAPI_H
2N/A#define _KMFAPI_H
2N/A
2N/A#include <kmftypes.h>
2N/A#include <security/cryptoki.h>
2N/A
2N/A#ifdef __cplusplus
2N/Aextern "C" {
2N/A#endif
2N/A
2N/A/*
2N/A * Setup operations.
2N/A */
2N/Aextern KMF_RETURN kmf_initialize(KMF_HANDLE_T *, char *, char *);
2N/Aextern KMF_RETURN kmf_configure_keystore(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_finalize(KMF_HANDLE_T);
2N/A
2N/A/*
2N/A * Key operations.
2N/A */
2N/Aextern KMF_RETURN kmf_create_keypair(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_delete_key_from_keystore(KMF_HANDLE_T, int,
2N/A KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_find_key(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_find_prikey_by_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_store_key(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_create_sym_key(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_get_sym_key_value(KMF_HANDLE_T, KMF_KEY_HANDLE *,
2N/A KMF_RAW_SYM_KEY *);
2N/A
2N/A/*
2N/A * Certificate operations.
2N/A */
2N/Aextern KMF_RETURN kmf_find_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_encode_cert_record(KMF_X509_CERTIFICATE *, KMF_DATA *);
2N/A
2N/Aextern KMF_RETURN kmf_import_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_store_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_delete_cert_from_keystore(KMF_HANDLE_T, int,
2N/A KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_validate_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_create_cert_file(const KMF_DATA *, KMF_ENCODE_FORMAT,
2N/A char *);
2N/A
2N/Aextern KMF_RETURN kmf_download_cert(KMF_HANDLE_T, char *, char *, int,
2N/A unsigned int, char *, KMF_ENCODE_FORMAT *);
2N/A
2N/Aextern KMF_RETURN kmf_is_cert_data(KMF_DATA *, KMF_ENCODE_FORMAT *);
2N/Aextern KMF_RETURN kmf_is_cert_file(KMF_HANDLE_T, char *, KMF_ENCODE_FORMAT *);
2N/A
2N/Aextern KMF_RETURN kmf_check_cert_date(KMF_HANDLE_T, const KMF_DATA *);
2N/A
2N/A/*
2N/A * Crypto operations with key or cert.
2N/A */
2N/Aextern KMF_RETURN kmf_encrypt(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_decrypt(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_sign_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_sign_data(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_verify_cert(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_verify_data(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/A/*
2N/A * CRL operations.
2N/A */
2N/Aextern KMF_RETURN kmf_import_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_delete_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_list_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_find_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_find_cert_in_crl(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_verify_crl_file(KMF_HANDLE_T, char *, KMF_DATA *);
2N/Aextern KMF_RETURN kmf_check_crl_date(KMF_HANDLE_T, char *);
2N/Aextern KMF_RETURN kmf_download_crl(KMF_HANDLE_T, char *, char *,
2N/A int, unsigned int, char *, KMF_ENCODE_FORMAT *);
2N/Aextern KMF_RETURN kmf_is_crl_file(KMF_HANDLE_T, char *, KMF_ENCODE_FORMAT *);
2N/A
2N/A/*
2N/A * CSR operations.
2N/A */
2N/Aextern KMF_RETURN kmf_create_csr_file(KMF_DATA *, KMF_ENCODE_FORMAT, char *);
2N/Aextern KMF_RETURN kmf_set_csr_pubkey(KMF_HANDLE_T,
2N/A KMF_KEY_HANDLE *, KMF_CSR_DATA *);
2N/Aextern KMF_RETURN kmf_set_csr_version(KMF_CSR_DATA *, uint32_t);
2N/Aextern KMF_RETURN kmf_set_csr_subject(KMF_CSR_DATA *, KMF_X509_NAME *);
2N/Aextern KMF_RETURN kmf_set_csr_extn(KMF_CSR_DATA *, KMF_X509_EXTENSION *);
2N/Aextern KMF_RETURN kmf_set_csr_sig_alg(KMF_CSR_DATA *, KMF_ALGORITHM_INDEX);
2N/Aextern KMF_RETURN kmf_set_csr_subject_altname(KMF_CSR_DATA *, char *,
2N/A int, KMF_GENERALNAMECHOICES);
2N/Aextern KMF_RETURN kmf_set_csr_ku(KMF_CSR_DATA *, int, uint16_t);
2N/Aextern KMF_RETURN kmf_decode_csr(KMF_HANDLE_T, KMF_DATA *, KMF_CSR_DATA *);
2N/Aextern KMF_RETURN kmf_verify_csr(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern KMF_RETURN kmf_sign_csr(KMF_HANDLE_T, const KMF_CSR_DATA *,
2N/A KMF_KEY_HANDLE *, KMF_DATA *);
2N/Aextern KMF_RETURN kmf_add_csr_eku(KMF_CSR_DATA *, KMF_OID *, int);
2N/A
2N/A/*
2N/A * GetCert operations.
2N/A */
2N/Aextern KMF_RETURN kmf_get_cert_extn(const KMF_DATA *, KMF_OID *,
2N/A KMF_X509_EXTENSION *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_extns(const KMF_DATA *, KMF_FLAG_CERT_EXTN,
2N/A KMF_X509_EXTENSION **, int *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_ku(const KMF_DATA *, KMF_X509EXT_KEY_USAGE *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_eku(const KMF_DATA *, KMF_X509EXT_EKU *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_basic_constraint(const KMF_DATA *,
2N/A KMF_BOOL *, KMF_X509EXT_BASICCONSTRAINTS *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_policies(const KMF_DATA *,
2N/A KMF_BOOL *, KMF_X509EXT_CERT_POLICIES *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_auth_info_access(const KMF_DATA *,
2N/A KMF_X509EXT_AUTHINFOACCESS *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_crl_dist_pts(const KMF_DATA *,
2N/A KMF_X509EXT_CRLDISTPOINTS *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_version_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_subject_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_issuer_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_serial_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_start_date_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_end_date_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_pubkey_alg_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_sig_alg_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_pubkey_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_email_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_extn_str(KMF_HANDLE_T, const KMF_DATA *,
2N/A KMF_PRINTABLE_ITEM, char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_id_data(const KMF_DATA *, KMF_DATA *);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_id_str(const KMF_DATA *, char **);
2N/A
2N/Aextern KMF_RETURN kmf_get_cert_validity(const KMF_DATA *, time_t *, time_t *);
2N/A
2N/A
2N/A/*
2N/A * SetCert operations
2N/A */
2N/Aextern KMF_RETURN kmf_set_cert_pubkey(KMF_HANDLE_T, KMF_KEY_HANDLE *,
2N/A KMF_X509_CERTIFICATE *);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_subject(KMF_X509_CERTIFICATE *,
2N/A KMF_X509_NAME *);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_ku(KMF_X509_CERTIFICATE *, int, uint16_t);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_issuer(KMF_X509_CERTIFICATE *,
2N/A KMF_X509_NAME *);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_sig_alg(KMF_X509_CERTIFICATE *,
2N/A KMF_ALGORITHM_INDEX);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_validity(KMF_X509_CERTIFICATE *,
2N/A time_t, uint32_t);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_serial(KMF_X509_CERTIFICATE *,
2N/A KMF_BIGINT *);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_version(KMF_X509_CERTIFICATE *, uint32_t);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_issuer_altname(KMF_X509_CERTIFICATE *,
2N/A int, KMF_GENERALNAMECHOICES, char *);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_subject_altname(KMF_X509_CERTIFICATE *,
2N/A int, KMF_GENERALNAMECHOICES, char *);
2N/A
2N/Aextern KMF_RETURN kmf_add_cert_eku(KMF_X509_CERTIFICATE *, KMF_OID *, int);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_extn(KMF_X509_CERTIFICATE *,
2N/A KMF_X509_EXTENSION *);
2N/A
2N/Aextern KMF_RETURN kmf_set_cert_basic_constraint(KMF_X509_CERTIFICATE *,
2N/A KMF_BOOL, KMF_X509EXT_BASICCONSTRAINTS *);
2N/A
2N/A
2N/A/*
2N/A * PK12 operations
2N/A */
2N/Aextern KMF_RETURN kmf_export_pk12(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_build_pk12(KMF_HANDLE_T, int, KMF_X509_DER_CERT *,
2N/A int, KMF_KEY_HANDLE *, KMF_CREDENTIAL *, char *);
2N/A
2N/Aextern KMF_RETURN kmf_import_objects(KMF_HANDLE_T, char *, KMF_CREDENTIAL *,
2N/A KMF_X509_DER_CERT **, int *, KMF_RAW_KEY_DATA **, int *);
2N/A
2N/A/*
2N/A * OCSP operations
2N/A */
2N/Aextern KMF_RETURN kmf_get_ocsp_for_cert(KMF_HANDLE_T, KMF_DATA *, KMF_DATA *,
2N/A KMF_DATA *);
2N/A
2N/Aextern KMF_RETURN kmf_create_ocsp_request(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/A
2N/Aextern KMF_RETURN kmf_get_encoded_ocsp_response(KMF_HANDLE_T, char *,
2N/A char *, int, char *, int, char *, unsigned int);
2N/A
2N/Aextern KMF_RETURN kmf_get_ocsp_status_for_cert(KMF_HANDLE_T, int,
2N/A KMF_ATTRIBUTE *);
2N/A
2N/A/*
2N/A * Policy Operations
2N/A */
2N/Aextern KMF_RETURN kmf_set_policy(KMF_HANDLE_T, char *, char *);
2N/A
2N/A/*
2N/A * Error handling.
2N/A */
2N/Aextern KMF_RETURN kmf_get_plugin_error_str(KMF_HANDLE_T, char **);
2N/Aextern KMF_RETURN kmf_get_kmf_error_str(KMF_RETURN, char **);
2N/A
2N/A/*
2N/A * Miscellaneous
2N/A */
2N/Aextern KMF_RETURN kmf_dn_parser(char *, KMF_X509_NAME *);
2N/Aextern KMF_RETURN kmf_read_input_file(KMF_HANDLE_T, char *, KMF_DATA *);
2N/Aextern KMF_RETURN kmf_der_to_pem(KMF_OBJECT_TYPE, unsigned char *,
2N/A int, unsigned char **, int *);
2N/Aextern KMF_RETURN kmf_pem_to_der(unsigned char *, int, unsigned char **, int *);
2N/Aextern char *kmf_oid_to_string(KMF_OID *);
2N/Aextern KMF_RETURN kmf_string_to_oid(char *, KMF_OID *);
2N/Aextern int kmf_compare_rdns(KMF_X509_NAME *, KMF_X509_NAME *);
2N/Aextern KMF_RETURN kmf_get_data_format(KMF_DATA *, KMF_ENCODE_FORMAT *);
2N/Aextern KMF_RETURN kmf_get_file_format(char *, KMF_ENCODE_FORMAT *);
2N/Aextern uint32_t kmf_string_to_ku(char *);
2N/Aextern char *kmf_ku_to_string(uint32_t);
2N/Aextern KMF_RETURN kmf_hexstr_to_bytes(unsigned char *, unsigned char **,
2N/A size_t *);
2N/A
2N/Aextern KMF_RETURN kmf_get_plugin_info(KMF_HANDLE_T, char *,
2N/A KMF_KEYSTORE_TYPE *, char **);
2N/A
2N/Aextern KMF_OID *kmf_ekuname_to_oid(char *);
2N/Aextern char *kmf_oid_to_ekuname(KMF_OID *);
2N/A
2N/A#define KMF_CompareRDNs kmf_compare_rdns
2N/A
2N/A/*
2N/A * Memory cleanup operations
2N/A */
2N/Aextern void kmf_free_dn(KMF_X509_NAME *);
2N/Aextern void kmf_free_kmf_cert(KMF_HANDLE_T, KMF_X509_DER_CERT *);
2N/Aextern void kmf_free_data(KMF_DATA *);
2N/Aextern void kmf_free_algoid(KMF_X509_ALGORITHM_IDENTIFIER *);
2N/Aextern void kmf_free_extn(KMF_X509_EXTENSION *);
2N/Aextern void kmf_free_tbs_csr(KMF_TBS_CSR *);
2N/Aextern void kmf_free_signed_csr(KMF_CSR_DATA *);
2N/Aextern void kmf_free_tbs_cert(KMF_X509_TBS_CERT *);
2N/Aextern void kmf_free_signed_cert(KMF_X509_CERTIFICATE *);
2N/Aextern void kmf_free_str(char *);
2N/Aextern void kmf_free_eku(KMF_X509EXT_EKU *);
2N/Aextern void kmf_free_spki(KMF_X509_SPKI *);
2N/Aextern void kmf_free_kmf_key(KMF_HANDLE_T, KMF_KEY_HANDLE *);
2N/Aextern void kmf_free_bigint(KMF_BIGINT *);
2N/Aextern void kmf_free_raw_key(KMF_RAW_KEY_DATA *);
2N/Aextern void kmf_free_raw_sym_key(KMF_RAW_SYM_KEY *);
2N/Aextern void kmf_free_crl_dist_pts(KMF_X509EXT_CRLDISTPOINTS *);
2N/A
2N/A/* APIs for PKCS#11 token */
2N/Aextern KMF_RETURN kmf_pk11_token_lookup(KMF_HANDLE_T, char *, CK_SLOT_ID *);
2N/Aextern KMF_RETURN kmf_pk11_init_token(KMF_HANDLE_T,
2N/A char *, char *, CK_UTF8CHAR_PTR, CK_ULONG);
2N/Aextern KMF_RETURN kmf_set_token_pin(KMF_HANDLE_T, int, KMF_ATTRIBUTE *);
2N/Aextern CK_SESSION_HANDLE kmf_get_pk11_handle(KMF_HANDLE_T);
2N/A
2N/A/*
2N/A * Attribute management routines.
2N/A */
2N/Aint kmf_find_attr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int);
2N/Avoid *kmf_get_attr_ptr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int);
2N/AKMF_RETURN kmf_get_attr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int, void *,
2N/A uint32_t *);
2N/AKMF_RETURN kmf_get_string_attr(KMF_ATTR_TYPE, KMF_ATTRIBUTE *, int, char **);
2N/AKMF_RETURN kmf_set_attr(KMF_ATTRIBUTE *, int, KMF_ATTR_TYPE, void *, uint32_t);
2N/Avoid kmf_set_attr_at_index(KMF_ATTRIBUTE *, int, KMF_ATTR_TYPE,
2N/A void *, uint32_t);
2N/A
2N/A/*
2N/A * Certificate to name mapping functions.
2N/A */
2N/AKMF_RETURN kmf_cert_to_name_mapping_initialize(KMF_HANDLE_T, int,
2N/A KMF_ATTRIBUTE *);
2N/AKMF_RETURN kmf_cert_to_name_mapping_finalize(KMF_HANDLE_T);
2N/AKMF_RETURN kmf_map_cert_to_name(KMF_HANDLE_T, KMF_DATA *, KMF_DATA *);
2N/AKMF_RETURN kmf_match_cert_to_name(KMF_HANDLE_T, KMF_DATA *, KMF_DATA *,
2N/A KMF_DATA *);
2N/AKMF_RETURN kmf_get_mapper_error_str(KMF_HANDLE_T, char **);
2N/A/*
2N/A * Helper functions for handling the mapper internal state. They are part of the
2N/A * public interface, too.
2N/A */
2N/Avoid kmf_set_mapper_lasterror(KMF_HANDLE_T, uint32_t);
2N/Auint32_t kmf_get_mapper_lasterror(KMF_HANDLE_T);
2N/Avoid kmf_set_mapper_options(KMF_HANDLE_T, void *);
2N/Avoid *kmf_get_mapper_options(KMF_HANDLE_T);
2N/A
2N/A#ifdef __cplusplus
2N/A}
2N/A#endif
2N/A#endif /* _KMFAPI_H */