xref: /illumos-gate/usr/src/man/man3lib/libkmf.3lib (revision ed093b41a93e8563e6e1e5dae0768dda2a7bcc27)
te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Copyright 2018 OmniOS Community Edition (OmniOSce) Association.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
LIBKMF 3LIB "Mar 21, 2018"
NAME
libkmf - Key Management Framework library
SYNOPSIS

cc [ flag... ] file... -lkmf [ library... ]
#include <kmfapi.h>
DESCRIPTION

These functions comprise the Key Management Framework library. They are intended to be used by applications that need to perform operations involving the creation and management of public key objects such as public/private key pairs, certificates, certificate signing requests, certificate validation, certificate revocation lists, and OCSP response processing.

INTERFACES

The shared object libkmf.so.1 provides the public interfaces defined below. See Intro(3) for additional information on shared object interfaces.

kmf_add_cert_eku kmf_add_csr_eku
kmf_add_policy_to_db kmf_build_pk12
kmf_check_cert_date kmf_check_crl_date
kmf_compare_rdns kmf_configure_keystore
kmf_create_cert_file kmf_create_csr_file
kmf_create_keypair kmf_create_ocsp_request
kmf_create_sym_key kmf_decode_csr
kmf_decrypt kmf_delete_cert_from_keystore
kmf_delete_crl kmf_delete_key_from_keystore
kmf_delete_policy_from_db kmf_der_to_pem
kmf_dn_parser kmf_dn_to_string
kmf_download_cert kmf_download_crl
kmf_ekuname_to_oid kmf_encode_cert_record
kmf_encrypt kmf_export_pk12
kmf_finalize kmf_find_attr
kmf_find_cert kmf_find_cert_in_crl
kmf_find_crl kmf_find_key
kmf_find_prikey_by_cert kmf_free_algoid
kmf_free_bigint kmf_free_crl_dist_pts
kmf_free_data kmf_free_dn
kmf_free_eku kmf_free_eku_policy
kmf_free_extn kmf_free_kmf_cert
kmf_free_kmf_key kmf_free_policy_record
kmf_free_raw_key kmf_free_raw_sym_key
kmf_free_signed_cert kmf_free_signed_csr
kmf_free_spki kmf_free_str
kmf_free_tbs_cert kmf_free_tbs_csr
kmf_get_attr kmf_get_attr_ptr
kmf_get_cert_auth_info_access kmf_get_cert_basic_constraint
kmf_get_cert_crl_dist_pts kmf_get_cert_eku
kmf_get_cert_email_str kmf_get_cert_end_date_str
kmf_get_cert_extn kmf_get_cert_extn_str
kmf_get_cert_id_data kmf_get_cert_id_str
kmf_get_cert_issuer_str kmf_get_cert_ku
kmf_get_cert_policies kmf_get_cert_pubkey_alg_str
kmf_get_cert_pubkey_str kmf_get_cert_serial_str
kmf_get_cert_sig_alg_str kmf_get_cert_start_date_str
kmf_get_cert_subject_str kmf_get_cert_validity
kmf_get_cert_version_str kmf_get_data_format
kmf_get_encoded_ocsp_response kmf_get_file_format
kmf_get_kmf_error_str kmf_get_ocsp_for_cert
kmf_get_ocsp_status_for_cert kmf_get_pk11_handle
kmf_get_plugin_error_str kmf_get_policy
kmf_get_string_attr kmf_get_sym_key_value
kmf_hexstr_to_bytes kmf_import_crl
kmf_import_cert kmf_import_objects
kmf_initialize kmf_is_cert_data
kmf_is_cert_file kmf_is_crl_file
kmf_ku_to_string kmf_list_crl
kmf_oid_to_ekuname kmf_oid_to_string
kmf_pem_to_der kmf_pk11_token_lookup
kmf_read_input_file kmf_select_token
kmf_set_attr kmf_set_attr_at_index
kmf_set_cert_basic_constraint kmf_set_cert_extn
kmf_set_cert_issuer kmf_set_cert_issuer_altname
kmf_set_cert_ku kmf_set_cert_pubkey
kmf_set_cert_serial kmf_set_cert_sig_alg
kmf_set_cert_subject kmf_set_cert_subject_altname
kmf_set_cert_validity kmf_set_cert_version
kmf_set_csr_extn kmf_set_csr_ku
kmf_set_csr_pubkey kmf_set_csr_sig_alg
kmf_set_csr_subject kmf_set_csr_subject_altname
kmf_set_csr_version kmf_set_policy
kmf_set_token_pin kmf_sign_cert
kmf_sign_csr kmf_sign_data
kmf_store_cert kmf_store_key
kmf_string_to_ku kmf_string_to_oid
kmf_validate_cert kmf_verify_cert
kmf_verify_crl_file kmf_verify_csr
kmf_verify_data kmf_verify_policy
FILES
/lib/libkmf.so.1

shared object

/lib/64/libkmf.so.1

64-bit shared object

/usr/include/kmfapi.h

KMF function definitions

/usr/include/kmftypes.h

KMF structures and types.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO

kmfcfg (1), pktool (1), attributes (7)

Solaris Security for Developers Guide