OpenSSL Manual Pages

Mon Jan 8 01:51:38 PM JST 2024

Introduction

The OpenSSL apps library implements a wide range of security algorithms. The library functions are used by OpenSSL implementations of SSL, TLS and S/MIME. In addition, they are used in well-known software such as SSH, OpenPGP, and others. Sections: man1 man3 man5 man7

640 pages

Alphabetical Listing

Below is the list of available manual pages in section man3, sorted alphabetically for a quick lookup.

1	ADMISSIONS	Accessors and settors for ADMISSION_SYNTAX
2	ASN1_aux_cb	ASN.1 auxiliary data
3	ASN1_EXTERN_FUNCS	ASN.1 external function support
4	ASN1_generate_nconf	ASN1 string generation functions
5	ASN1_INTEGER_get_int64	ASN.1 INTEGER and ENUMERATED utilities
6	ASN1_INTEGER_new	ASN1_INTEGER allocation functions
7	ASN1_item_d2i_bio	decode and encode DER-encoded ASN.1 structures
8	ASN1_ITEM_lookup	lookup ASN.1 structures
9	ASN1_item_new	create new ASN.1 values
10	ASN1_item_sign	ASN1 sign and verify
11	ASN1_OBJECT_new	object allocation functions
12	ASN1_STRING_length	ASN1_STRING utility functions
13	ASN1_STRING_new	ASN1_STRING allocation functions
14	ASN1_STRING_print_ex	ASN1_STRING output routines
15	ASN1_STRING_TABLE_add	ASN1_STRING_TABLE manipulation functions
16	ASN1_TIME_set	ASN.1 Time functions
17	ASN1_TYPE_get	ASN1_TYPE utility functions
18	ASYNC_start_job	asynchronous job management functions
19	ASYNC_WAIT_CTX_new	functions to manage waiting for asynchronous jobs to complete
20	b2i_PVK_bio_ex	Decode and encode functions for reading and writing MSBLOB format private keys
21	BF_encrypt	Blowfish encryption
22	BIO_ADDRINFO	BIO_ADDRINFO type and routines
23	BIO_ADDR	BIO_ADDR routines
24	BIO_connect	BIO socket communication setup routines
25	BIO_ctrl	BIO control operations
26	BIO_f_base64	base64 BIO filter
27	BIO_f_buffer	buffering BIO
28	BIO_f_cipher	cipher BIO filter
29	BIO_find_type	BIO chain traversal
30	BIO_f_md	message digest BIO filter
31	BIO_f_null	null filter
32	BIO_f_prefix	prefix BIO filter
33	BIO_f_readbuffer	read only buffering BIO that supports BIO_tell() and BIO_seek()
34	BIO_f_ssl	SSL BIO
35	BIO_get_data	functions for managing BIO state information
36	BIO_get_ex_new_index	application-specific data
37	BIO_get_rpoll_descriptor	obtain a structure which can be used to determine when a BIO object can next be read or written
38	BIO_meth_new	Routines to build up BIO methods
39	BIO_new_CMS	CMS streaming filter BIO
40	BIO_new	BIO allocation and freeing functions
41	BIO_parse_hostserv	utility routines to parse a standard host and service string
42	BIO_printf	formatted output to a BIO
43	BIO_push	add and remove BIOs from a chain
44	BIO_read	BIO I/O functions
45	BIO_s_accept	accept BIO
46	BIO_s_bio	BIO pair BIO
47	BIO_s_connect	connect BIO
48	BIO_s_core	OSSL_CORE_BIO functions
49	BIO_s_datagram	Network BIO with datagram semantics
50	BIO_s_dgram_pair	datagram pair BIO
51	BIO_sendmmsg	send and receive multiple datagrams in a single call
52	BIO_set_callback	BIO callback functions
53	BIO_s_fd	file descriptor BIO
54	BIO_s_file	FILE bio
55	BIO_should_retry	BIO retry functions
56	BIO_s_mem	memory BIO
57	BIO_s_null	null data sink
58	BIO_socket_wait	BIO connection utility functions
59	BIO_s_socket	socket BIO
60	BN_add	arithmetic operations on BIGNUMs
61	BN_add_word	arithmetic functions on BIGNUMs with integers
62	BN_BLINDING_new	blinding related BIGNUM functions
63	BN_bn2bin	format conversions
64	BN_cmp	BIGNUM comparison and test functions
65	BN_copy	copy BIGNUMs
66	BN_CTX_new	allocate and free BN_CTX structures
67	BN_CTX_start	use temporary BIGNUM variables
68	BN_generate_prime	generate primes and test for primality
69	BN_mod_exp_mont	Montgomery exponentiation
70	BN_mod_inverse	compute inverse modulo n
71	BN_mod_mul_montgomery	Montgomery multiplication
72	BN_mod_mul_reciprocal	modular multiplication using reciprocal
73	BN_new	allocate and free BIGNUMs
74	BN_num_bytes	get BIGNUM size
75	BN_rand	generate pseudo-random number
76	BN_security_bits	returns bits of security based on given numbers
77	BN_set_bit	bit operations on BIGNUMs
78	BN_swap	exchange BIGNUMs
79	BN_zero	BIGNUM assignment operations
80	BUF_MEM_new	simple character array structure
81	CMS_add0_cert	CMS certificate and CRL utility functions
82	CMS_add1_recipient_cert	add recipients to a CMS enveloped data structure
83	CMS_add1_signer	add a signer to a CMS_ContentInfo signed data structure
84	CMS_compress	create a CMS CompressedData structure
85	CMS_data_create	Create CMS Data object
86	CMS_decrypt	decrypt content from a CMS envelopedData structure
87	CMS_digest_create	Create CMS DigestedData object
88	CMS_EncryptedData_decrypt	Decrypt CMS EncryptedData or EnvelopedData
89	CMS_EncryptedData_encrypt	Create CMS EncryptedData
90	CMS_encrypt	create a CMS envelopedData structure
91	CMS_EnvelopedData_create	Create CMS envelope
92	CMS_final	finalise a CMS_ContentInfo structure
93	CMS_get0_RecipientInfos	CMS envelopedData RecipientInfo routines
94	CMS_get0_SignerInfos	CMS signedData signer functions
95	CMS_get0_type	get and set CMS content types and content
96	CMS_get1_ReceiptRequest	CMS signed receipt request functions
97	CMS_sign_receipt	create a CMS signed receipt
98	CMS_sign	create a CMS SignedData structure
99	CMS_uncompress	uncompress a CMS CompressedData structure
100	CMS_verify_receipt	verify a CMS signed receipt
101	CMS_verify	verify a CMS SignedData structure
102	COMP_CTX_new	Compression support
103	CONF_modules_free	OpenSSL configuration cleanup functions
104	CONF_modules_load_file	OpenSSL configuration functions
105	CRYPTO_get_ex_new_index	functions supporting application-specific data
106	CRYPTO_memcmp	Constant time memory comparison
107	CRYPTO_THREAD_run_once	OpenSSL thread support
108	CTLOG_new	encapsulates information about a Certificate Transparency log
109	CTLOG_STORE_get0_log_by_id	Get a Certificate Transparency log from a CTLOG_STORE
110	CTLOG_STORE_new	Create and populate a Certificate Transparency log list
111	CT_POLICY_EVAL_CTX_new	Encapsulates the data required to evaluate whether SCTs meet a Certificate Transparency policy
112	d2i_PKCS8PrivateKey_bio	PKCS#8 format private key functions
113	d2i_PrivateKey	decode and encode functions for reading and saving EVP_PKEY structures
114	d2i_RSAPrivateKey	DEPRECATED
115	d2i_SSL_SESSION	convert SSL_SESSION object from/to ASN1 representation
116	d2i_X509	convert objects from/to ASN.1/DER representation
117	DEFINE_STACK_OF	stack container
118	DES_random_key	DES encryption
119	DH_generate_key	perform Diffie-Hellman key exchange
120	DH_generate_parameters	generate and check Diffie-Hellman parameters
121	DH_get0_pqg	Routines for getting and setting data in a DH object
122	DH_get_1024_160	Create standardized public primes or DH pairs
123	DH_meth_new	Routines to build up DH methods
124	DH_new_by_nid	create or get DH named parameters
125	DH_new	allocate and free DH objects
126	DH_set_method	select DH method
127	DH_size	get Diffie-Hellman prime size and security bits
128	DSA_do_sign	raw DSA signature operations
129	DSA_dup_DH	create a DH structure out of DSA structure
130	DSA_generate_key	generate DSA key pair
131	DSA_generate_parameters	generate DSA parameters
132	DSA_get0_pqg	Routines for getting and setting data in a DSA object
133	DSA_meth_new	Routines to build up DSA methods
134	DSA_new	allocate and free DSA objects
135	DSA_set_method	select DSA method
136	DSA_SIG_new	allocate and free DSA signature objects
137	DSA_sign	DSA signatures
138	DSA_size	get DSA signature size, key bits or security bits
139	DTLS_get_data_mtu	Get maximum data payload size
140	DTLS_set_timer_cb	Set callback for controlling DTLS timer duration
141	DTLSv1_get_timeout	determine when a DTLS or QUIC SSL object next needs a timeout event to be handled
142	DTLSv1_handle_timeout	handle a pending timeout event for a DTLS or QUIC SSL object
143	DTLSv1_listen	Statelessly listen for incoming connections
144	ECDSA_SIG_new	Functions for creating, destroying and manipulating ECDSA_SIG objects
145	ECDSA_sign	deprecated low-level elliptic curve digital signature algorithm (ECDSA) functions
146	EC_GFp_simple_method	Functions for obtaining EC_METHOD objects
147	EC_GROUP_copy	Functions for manipulating EC_GROUP objects
148	EC_GROUP_new	Functions for creating and destroying EC_GROUP objects
149	EC_KEY_get_enc_flags	Get and set flags for encoding EC_KEY structures
150	EC_KEY_new	Functions for creating, destroying and manipulating EC_KEY objects
151	ECPKParameters_print	Functions for decoding and encoding ASN1 representations of elliptic curve entities
152	EC_POINT_add	Functions for performing mathematical operations and tests on EC_POINT objects
153	EC_POINT_new	Functions for creating, destroying and manipulating EC_POINT objects
154	ENGINE_add	ENGINE cryptographic module support
155	ERR_clear_error	clear the error queue
156	ERR_error_string	obtain human-readable error message
157	ERR_get_error	obtain error code and data
158	ERR_GET_LIB	get information from error codes
159	ERR_load_crypto_strings	load and free error strings
160	ERR_load_strings	load arbitrary error strings
161	ERR_new	Error recording building blocks
162	ERR_print_errors	print error messages
163	ERR_put_error	record an error
164	ERR_remove_state	DEPRECATED
165	ERR_set_mark	set mark, clear mark, pop errors until mark and pop last error
166	EVP_aes_128_gcm	EVP AES cipher
167	EVP_aria_128_gcm	EVP ARIA cipher
168	EVP_ASYM_CIPHER_free	Functions to manage EVP_ASYM_CIPHER algorithm objects
169	EVP_bf_cbc	EVP Blowfish cipher
170	EVP_blake2b512	BLAKE2 For EVP
171	EVP_BytesToKey	password based encryption routine
172	EVP_camellia_128_ecb	EVP Camellia cipher
173	EVP_cast5_cbc	EVP CAST cipher
174	EVP_chacha20	EVP ChaCha20 stream cipher
175	EVP_CIPHER_CTX_get_cipher_data	Routines to inspect and modify EVP_CIPHER_CTX objects
176	EVP_CIPHER_CTX_get_original_iv	Routines to inspect EVP_CIPHER_CTX IV data
177	EVP_CIPHER_meth_new	Routines to build up EVP_CIPHER methods
178	EVP_des_cbc	EVP DES cipher
179	EVP_desx_cbc	EVP DES-X cipher
180	EVP_DigestInit	EVP digest routines
181	EVP_DigestSignInit	EVP signing functions
182	EVP_DigestVerifyInit	EVP signature verification functions
183	EVP_EncodeInit	EVP base 64 encode/decode routines
184	EVP_EncryptInit	EVP cipher routines
185	EVP_idea_cbc	EVP IDEA cipher
186	EVP_KDF	EVP KDF routines
187	EVP_KEM_free	Functions to manage EVP_KEM algorithm objects
188	EVP_KEYEXCH_free	Functions to manage EVP_KEYEXCH algorithm objects
189	EVP_KEYMGMT	EVP key management routines
190	EVP_MAC	EVP MAC routines
191	EVP_md2	MD2 For EVP
192	EVP_md4	MD4 For EVP
193	EVP_md5	MD5 For EVP
194	EVP_mdc2	MDC-2 For EVP
195	EVP_MD_meth_new	Routines to build up legacy EVP_MD methods
196	EVP_OpenInit	EVP envelope decryption
197	EVP_PBE_CipherInit	Password based encryption routines
198	EVP_PKEY2PKCS8	Convert a private key to/from PKCS8
199	EVP_PKEY_asn1_get_count	enumerate public key ASN.1 methods
200	EVP_PKEY_ASN1_METHOD	manipulating and registering EVP_PKEY_ASN1_METHOD structure
201	EVP_PKEY_check	key and parameter validation functions
202	EVP_PKEY_copy_parameters	public key parameter and comparison functions
203	EVP_PKEY_CTX_ctrl	algorithm specific control operations
204	EVP_PKEY_CTX_get0_libctx	functions for getting diverse information from an EVP_PKEY_CTX
205	EVP_PKEY_CTX_get0_pkey	functions for accessing the EVP_PKEY associated with an EVP_PKEY_CTX
206	EVP_PKEY_CTX_new	public key algorithm context functions
207	EVP_PKEY_CTX_set1_pbe_pass	generic KDF support functions
208	EVP_PKEY_CTX_set_hkdf_md	HMAC-based Extract-and-Expand key derivation algorithm
209	EVP_PKEY_CTX_set_params	provider parameter passing operations
210	EVP_PKEY_CTX_set_rsa_pss_keygen_md	EVP_PKEY RSA-PSS algorithm support functions
211	EVP_PKEY_CTX_set_scrypt_N	EVP_PKEY scrypt KDF support functions
212	EVP_PKEY_CTX_set_tls1_prf_md	TLS PRF key derivation algorithm
213	EVP_PKEY_decapsulate	Key decapsulation using a KEM algorithm with a private key
214	EVP_PKEY_decrypt	decrypt using a public key algorithm
215	EVP_PKEY_derive	derive public key algorithm shared secret
216	EVP_PKEY_digestsign_supports_digest	indicate support for signature digest
217	EVP_PKEY_encapsulate	Key encapsulation using a KEM algorithm with a public key
218	EVP_PKEY_encrypt	encrypt using a public key algorithm
219	EVP_PKEY_fromdata	functions to create keys and key parameters from user data
220	EVP_PKEY_get_default_digest_nid	get default signature digest
221	EVP_PKEY_get_field_type	get field type or point conversion form of a key
222	EVP_PKEY_get_group_name	get group name of a key
223	EVP_PKEY_get_size	EVP_PKEY information functions
224	EVP_PKEY_gettable_params	retrieve key parameters from a key
225	EVP_PKEY_is_a	key type and capabilities functions
226	EVP_PKEY_keygen	key and parameter generation and check functions
227	EVP_PKEY_meth_get_count	enumerate public key methods
228	EVP_PKEY_meth_new	manipulating EVP_PKEY_METHOD structure
229	EVP_PKEY_new	public/private key allocation and raw key handling functions
230	EVP_PKEY_print_private	public key algorithm printing routines
231	EVP_PKEY_set1_encoded_public_key	functions to set and get public key data within an EVP_PKEY
232	EVP_PKEY_set1_RSA	EVP_PKEY assignment functions
233	EVP_PKEY_settable_params	set key parameters into a key
234	EVP_PKEY_set_type	functions to change the EVP_PKEY type
235	EVP_PKEY_sign	sign using a public key algorithm
236	EVP_PKEY_todata	functions to return keys as an array of key parameters
237	EVP_PKEY_verify_recover	recover signature using a public key algorithm
238	EVP_PKEY_verify	signature verification using a public key algorithm
239	EVP_RAND	EVP RAND routines
240	EVP_rc2_cbc	EVP RC2 cipher
241	EVP_rc4	EVP RC4 stream cipher
242	EVP_rc5_32_12_16_cbc	EVP RC5 cipher
243	EVP_ripemd160	RIPEMD160 For EVP
244	EVP_SealInit	EVP envelope encryption
245	EVP_seed_cbc	EVP SEED cipher
246	EVP_set_default_properties	Set default properties for future algorithm fetches
247	EVP_sha1	SHA-1 For EVP
248	EVP_sha224	SHA-2 For EVP
249	EVP_sha3_224	SHA-3 For EVP
250	EVP_SIGNATURE	Functions to manage EVP_SIGNATURE algorithm objects
251	EVP_SignInit	EVP signing functions
252	EVP_sm3	SM3 for EVP
253	EVP_sm4_cbc	EVP SM4 cipher
254	EVP_VerifyInit	EVP signature verification functions
255	EVP_whirlpool	WHIRLPOOL For EVP
256	HMAC	HMAC message authentication code
257	i2d_CMS_bio_stream	output CMS_ContentInfo structure in BER format
258	i2d_PKCS7_bio_stream	output PKCS7 structure in BER format
259	i2d_re_X509_tbs	X509 encode and decode functions
260	MD5	MD2, MD4, and MD5 hash functions
261	MDC2_Init	MDC2 hash function
262	NCONF_new_ex	functionality to Load and parse configuration files manually
263	o2i_SCT_LIST	decode and encode Signed Certificate Timestamp lists in TLS wire format
264	OBJ_nid2obj	ASN1 object utility functions
265	OCSP_cert_to_id	OCSP certificate ID utility functions
266	OCSP_request_add1_nonce	OCSP nonce functions
267	OCSP_REQUEST_new	OCSP request functions
268	OCSP_resp_find_status	OCSP response utility functions
269	OCSP_response_status	OCSP response functions
270	OCSP_sendreq_new	OCSP responder query functions
271	OpenSSL_add_all_algorithms	add algorithms to internal table
272	OPENSSL_Applink	glue between OpenSSL BIO and Win32 compiler run-time
273	OPENSSL_config	simple OpenSSL configuration functions
274	OPENSSL_FILE	generic C programming utility macros
275	OPENSSL_fork_prepare	OpenSSL fork handlers
276	OPENSSL_gmtime	platform-agnostic OpenSSL time routines
277	OPENSSL_hexchar2int	Hex encoding and decoding functions
278	OPENSSL_ia32cap	the x86[_64] processor capabilities vector
279	OPENSSL_init_crypto	OpenSSL initialisation and deinitialisation functions
280	OPENSSL_init_ssl	OpenSSL (libssl and libcrypto) initialisation
281	OPENSSL_instrument_bus	instrument references to memory bus
282	OPENSSL_LH_COMPFUNC	dynamic hash table
283	OPENSSL_LH_stats	LHASH statistics
284	OPENSSL_load_builtin_modules	add standard configuration modules
285	OPENSSL_malloc	Memory allocation functions
286	OPENSSL_s390xcap	the IBM z processor capabilities vector
287	OPENSSL_secure_malloc	secure heap storage
288	OPENSSL_strcasecmp	compare two strings ignoring case
289	OpenSSL_version	get OpenSSL version number and other information
290	OSSL_ALGORITHM	OpenSSL Core type to define a fetchable algorithm
291	OSSL_CALLBACK	OpenSSL Core type to define callbacks
292	OSSL_CMP_CTX_new	functions for managing the CMP client context data structure
293	OSSL_CMP_exec_certreq	functions implementing CMP client transactions
294	OSSL_CMP_HDR_get0_transactionID	functions manipulating CMP message headers
295	OSSL_CMP_ITAV_new_caCerts	CMP utility functions for handling specific genm and genp messages
296	OSSL_CMP_ITAV_set0	OSSL_CMP_ITAV utility functions
297	OSSL_CMP_log_open
298	OSSL_CMP_MSG_get0_header	function(s) manipulating CMP messages
299	OSSL_CMP_MSG_http_perform	client-side HTTP(S) transfer of a CMP request-response pair
300	OSSL_CMP_SRV_CTX_new	generic functions to set up and control a CMP server
301	OSSL_CMP_STATUSINFO_new	function(s) for managing the CMP PKIStatus
302	OSSL_CMP_validate_msg	functions for verifying CMP message protection
303	OSSL_CORE_MAKE_FUNC	OpenSSL reserved symbols
304	OSSL_CRMF_MSG_get0_tmpl	functions reading from CRMF CertReqMsg structures
305	OSSL_CRMF_MSG_set0_validity	functions populating and verifying CRMF CertReqMsg structures
306	OSSL_CRMF_MSG_set1_regCtrl_regToken	functions getting or setting CRMF Registration Controls
307	OSSL_CRMF_MSG_set1_regInfo_certReq	functions getting or setting CRMF Registration Info
308	OSSL_CRMF_pbmp_new	functions for producing Password-Based MAC (PBM)
309	OSSL_DECODER_CTX_new_for_pkey	Decoder routines to decode EVP_PKEYs
310	OSSL_DECODER_CTX	Decoder context routines
311	OSSL_DECODER_from_bio	Routines to perform a decoding
312	OSSL_DECODER	Decoder method routines
313	OSSL_DISPATCH	OpenSSL Core type to define a dispatchable function table
314	OSSL_ENCODER_CTX_new_for_pkey	Encoder routines to encode EVP_PKEYs
315	OSSL_ENCODER_CTX	Encoder context routines
316	OSSL_ENCODER	Encoder method routines
317	OSSL_ENCODER_to_bio	Routines to perform an encoding
318	OSSL_ERR_STATE_save	saving and restoring error state
319	OSSL_ESS_check_signing_certs	Enhanced Security Services (ESS) functions
320	OSSL_HPKE_CTX_new	Hybrid Public Key Encryption (HPKE) functions
321	OSSL_HTTP_parse_url	http utility functions
322	OSSL_HTTP_REQ_CTX	HTTP client low-level functions
323	OSSL_HTTP_transfer	HTTP client high-level functions
324	OSSL_ITEM	OpenSSL Core type for generic itemized data
325	OSSL_LIB_CTX	OpenSSL library context
326	OSSL_PARAM_allocate_from_text	OSSL_PARAM construction utilities
327	OSSL_PARAM_BLD	functions to assist in the creation of OSSL_PARAM arrays
328	OSSL_PARAM_dup	OSSL_PARAM array copy functions
329	OSSL_PARAM_int	OSSL_PARAM helpers
330	OSSL_PARAM	a structure to pass or request object parameters
331	OSSL_PROVIDER	provider routines
332	OSSL_QUIC_client_method	Provide SSL_METHOD objects for QUIC enabled functions
333	OSSL_SELF_TEST_new	functionality to trigger a callback during a self test
334	OSSL_SELF_TEST_set_callback	specify a callback for processing self tests
335	OSSL_sleep	delay execution for a specified number of milliseconds
336	OSSL_STORE_attach	Functions to read objects from a BIO
337	OSSL_STORE_expect	Specify what object type is expected
338	OSSL_STORE_INFO	Functions to manipulate OSSL_STORE_INFO objects
339	OSSL_STORE_LOADER	Types and functions to manipulate, register and unregister STORE loaders for different URI schemes
340	OSSL_STORE_open	Types and functions to read objects from a URI
341	OSSL_STORE_SEARCH	Type and functions to create OSSL_STORE search criteria
342	OSSL_trace_enabled	OpenSSL Tracing API
343	OSSL_trace_get_category_num	OpenSSL tracing information functions
344	OSSL_trace_set_channel	Enabling trace output
345	PEM_bytes_read_bio	read a PEM-encoded data structure from a BIO
346	PEM_read_bio_ex	read PEM format files with custom processing
347	PEM_read_bio_PrivateKey	PEM routines
348	PEM_read_CMS	PEM object encoding routines
349	PEM_read	PEM encoding routines
350	PEM_write_bio_CMS_stream	output CMS_ContentInfo structure in PEM format
351	PEM_write_bio_PKCS7_stream	output PKCS7 structure in PEM format
352	PEM_X509_INFO_read_bio_ex	read PEM-encoded data structures into one or more X509_INFO objects
353	PKCS12_add1_attr_by_NID	Add an attribute to a PKCS#12 safeBag structure
354	PKCS12_add_cert	Add an object to a set of PKCS#12 safeBags
355	PKCS12_add_CSPName_asc	Add a Microsoft CSP Name attribute to a PKCS#12 safeBag
356	PKCS12_add_friendlyname_asc	Functions to add the friendlyname attribute to a PKCS#12 safeBag
357	PKCS12_add_localkeyid	Add the localKeyId attribute to a PKCS#12 safeBag
358	PKCS12_add_safe	Create and add objects to a PKCS#12 structure
359	PKCS12_create	create a PKCS#12 structure
360	PKCS12_decrypt_skey	PKCS12 shrouded keyBag decrypt functions
361	PKCS12_gen_mac	Functions to create and manipulate a PKCS#12 structure
362	PKCS12_get_friendlyname	Retrieve the friendlyname attribute from a PKCS#12 safeBag
363	PKCS12_init	Create a new empty PKCS#12 structure
364	PKCS12_item_decrypt_d2i	PKCS12 item encrypt/decrypt functions
365	PKCS12_key_gen_utf8_ex	PKCS#12 Password based key derivation
366	PKCS12_newpass	change the password of a PKCS12 structure
367	PKCS12_pack_p7encdata	Pack a set of PKCS#12 safeBags into a PKCS#7 encrypted data object
368	PKCS12_parse	parse a PKCS#12 structure
369	PKCS12_PBE_keyivgen	PKCS#12 Password based encryption
370	PKCS12_SAFEBAG_create_cert	Create PKCS#12 safeBag objects
371	PKCS12_SAFEBAG_get0_attrs	Retrieve attributes from a PKCS#12 safeBag
372	PKCS12_SAFEBAG_get1_cert	Get objects from a PKCS#12 safeBag
373	PKCS12_SAFEBAG_set0_attrs	Set attributes for a PKCS#12 safeBag
374	PKCS5_PBE_keyivgen	PKCS#5 Password based encryption routines
375	PKCS5_PBKDF2_HMAC	password based derivation routines with salt and iteration count
376	PKCS7_decrypt	decrypt content from a PKCS#7 envelopedData structure
377	PKCS7_encrypt	create a PKCS#7 envelopedData structure
378	PKCS7_get_octet_string	return octet string from a PKCS#7 envelopedData structure
379	PKCS7_sign_add_signer	add information to PKCS7 structure
380	PKCS7_sign	create a PKCS#7 signedData structure
381	PKCS7_type_is_other	determine content type of PKCS#7 envelopedData structure
382	PKCS7_verify	verify a PKCS#7 signedData structure
383	PKCS8_encrypt	PKCS8 encrypt/decrypt functions
384	PKCS8_pkey_add1_attr	PKCS8 attribute functions
385	RAND_add	add randomness to the PRNG or get its status
386	RAND_bytes	generate random data
387	RAND_cleanup	erase the PRNG state
388	RAND_egd	query entropy gathering daemon
389	RAND_get0_primary	get access to the global EVP_RAND_CTX instances
390	RAND_load_file	PRNG seed file
391	RAND_set_DRBG_type	specify the global random number generator types
392	RAND_set_rand_method	select RAND method
393	RC4_set_key	RC4 encryption
394	RIPEMD160_Init	RIPEMD-160 hash function
395	RSA_blinding_on	protect the RSA operation from timing attacks
396	RSA_check_key	validate private RSA keys
397	RSA_generate_key	generate RSA key pair
398	RSA_get0_key	Routines for getting and setting data in an RSA object
399	RSA_meth_new	Routines to build up RSA methods
400	RSA_new	allocate and free RSA objects
401	RSA_padding_add_PKCS1_type_1	asymmetric encryption padding
402	RSA_print	print cryptographic parameters
403	RSA_private_encrypt	low-level signature operations
404	RSA_public_encrypt	RSA public key cryptography
405	RSA_set_method	select RSA method
406	RSA_sign_ASN1_OCTET_STRING	RSA signatures
407	RSA_sign	RSA signatures
408	RSA_size	get RSA modulus size or security bits
409	s2i_ASN1_IA5STRING	convert objects from/to ASN.1/string representation
410	SCT_new	A Certificate Transparency Signed Certificate Timestamp
411	SCT_print	Prints Signed Certificate Timestamps in a human-readable way
412	SCT_validate	checks Signed Certificate Timestamps (SCTs) are valid
413	SHA256_Init	Secure Hash Algorithm
414	SMIME_read_ASN1	parse S/MIME message
415	SMIME_read_CMS	parse S/MIME message
416	SMIME_read_PKCS7	parse S/MIME message
417	SMIME_write_ASN1	convert structure to S/MIME format
418	SMIME_write_CMS	convert CMS structure to S/MIME format
419	SMIME_write_PKCS7	convert PKCS#7 structure to S/MIME format
420	SRP_Calc_B	SRP authentication primitives
421	SRP_create_verifier	SRP authentication primitives
422	SRP_user_pwd_new	Functions to create a record of SRP user verifier information
423	SRP_VBASE_new	Functions to create and manage a stack of SRP user verifier information
424	SSL_accept	wait for a TLS/SSL client to initiate a TLS/SSL handshake
425	SSL_accept_stream	accept an incoming QUIC stream from a QUIC peer
426	SSL_alert_type_string	get textual description of alert information
427	SSL_alloc_buffers	manage SSL structure buffers
428	SSL_check_chain	check certificate chain suitability
429	SSL_CIPHER_get_name	get SSL_CIPHER properties
430	SSL_clear	reset SSL object to allow another connection
431	SSL_COMP_add_compression_method	handle SSL/TLS integrated compression methods
432	SSL_CONF_cmd_argv	SSL configuration command line processing
433	SSL_CONF_cmd	send configuration command
434	SSL_CONF_CTX_new	SSL configuration allocation functions
435	SSL_CONF_CTX_set1_prefix	Set configuration context command prefix
436	SSL_CONF_CTX_set_flags	Set or clear SSL configuration context flags
437	SSL_CONF_CTX_set_ssl_ctx	set context to configure
438	SSL_connect	initiate the TLS/SSL handshake with an TLS/SSL server
439	SSL_CTX_add1_chain_cert	extra chain certificate processing
440	SSL_CTX_add_extra_chain_cert	add, get or clear extra chain certificates
441	SSL_CTX_add_session	manipulate session cache
442	SSL_CTX_config	configure SSL_CTX or SSL structure
443	SSL_CTX_ctrl	internal handling functions for SSL_CTX and SSL objects
444	SSL_CTX_dane_enable	enable DANE TLS authentication of the remote TLS server in the local TLS client
445	SSL_CTX_flush_sessions	remove expired sessions
446	SSL_CTX_free	free an allocated SSL_CTX object
447	SSL_CTX_get0_param	get and set verification parameters
448	SSL_CTX_get_verify_mode	get currently set verification parameters
449	SSL_CTX_has_client_custom_ext	check whether a handler exists for a particular client extension type
450	SSL_CTX_load_verify_locations	set default locations for trusted CA certificates
451	SSL_CTX_new	create a new SSL_CTX object as framework for TLS/SSL or DTLS enabled functions
452	SSL_CTX_sessions	access internal session cache
453	SSL_CTX_sess_number	obtain session cache statistics
454	SSL_CTX_sess_set_cache_size	manipulate session cache size
455	SSL_CTX_sess_set_get_cb	provide callback functions for server side external session caching
456	SSL_CTX_set0_CA_list	get or set CA list
457	SSL_CTX_set1_cert_comp_preference	Certificate compression functions
458	SSL_CTX_set1_curves	EC supported curve functions
459	SSL_CTX_set1_sigalgs	set supported signature algorithms
460	SSL_CTX_set1_verify_cert_store	set certificate verification or chain store
461	SSL_CTX_set_alpn_select_cb	handle application layer protocol negotiation (ALPN)
462	SSL_CTX_set_cert_cb	handle certificate callback function
463	SSL_CTX_set_cert_store	manipulate X509 certificate verification storage
464	SSL_CTX_set_cert_verify_callback	set peer certificate verification procedure
465	SSL_CTX_set_cipher_list	choose list of available SSL_CIPHERs
466	SSL_CTX_set_client_cert_cb	handle client certificate callback function
467	SSL_CTX_set_client_hello_cb	callback functions for early server-side ClientHello processing
468	SSL_CTX_set_ctlog_list_file	load a Certificate Transparency log list from a file
469	SSL_CTX_set_ct_validation_callback	control Certificate Transparency policy
470	SSL_CTX_set_default_passwd_cb	set or get passwd callback for encrypted PEM file handling
471	SSL_CTX_set_generate_session_id	manipulate generation of SSL session IDs (server only)
472	SSL_CTX_set_info_callback	handle information callback for SSL connections
473	SSL_CTX_set_keylog_callback	logging TLS key material
474	SSL_CTX_set_max_cert_list	manipulate allowed size for the peer's certificate chain
475	SSL_CTX_set_min_proto_version	Get and set minimum and maximum supported protocol version
476	SSL_CTX_set_mode	manipulate SSL engine mode
477	SSL_CTX_set_msg_callback	install callback for observing protocol messages
478	SSL_CTX_set_num_tickets	control the number of TLSv1.3 session tickets that are issued
479	SSL_CTX_set_options	manipulate SSL options
480	SSL_CTX_set_psk_client_callback	set PSK client callback
481	SSL_CTX_set_quiet_shutdown	manipulate shutdown behaviour
482	SSL_CTX_set_read_ahead	manage whether to read as many input bytes as possible
483	SSL_CTX_set_record_padding_callback	install callback to specify TLS 1.3 record padding
484	SSL_CTX_set_security_level	SSL/TLS security framework
485	SSL_CTX_set_session_cache_mode	enable/disable session caching
486	SSL_CTX_set_session_id_context	set context within which session can be reused (server side only)
487	SSL_CTX_set_session_ticket_cb	manage session ticket application data
488	SSL_CTX_set_split_send_fragment	Control fragment size settings and pipelining operations
489	SSL_CTX_set_srp_password	SRP control operations
490	SSL_CTX_set_ssl_version	choose a new TLS/SSL method
491	SSL_CTX_set_stateless_cookie_generate_cb	Callback functions for stateless TLS1.3 cookies
492	SSL_CTX_set_timeout	manipulate timeout values for session caching
493	SSL_CTX_set_tlsext_servername_callback	handle server name indication (SNI)
494	SSL_CTX_set_tlsext_status_cb	OCSP Certificate Status Request functions
495	SSL_CTX_set_tlsext_ticket_key_cb	set a callback for session ticket processing
496	SSL_CTX_set_tlsext_use_srtp	Configure and query SRTP support
497	SSL_CTX_set_tmp_dh_callback	handle DH keys for ephemeral key exchange
498	SSL_CTX_set_tmp_ecdh	handle ECDH keys for ephemeral key exchange
499	SSL_CTX_set_verify	set various SSL/TLS parameters for peer certificate verification
500	SSL_CTX_use_certificate	load certificate and key data
501	SSL_CTX_use_psk_identity_hint	set PSK identity hint to use
502	SSL_CTX_use_serverinfo	use serverinfo extension
503	SSL_do_handshake	perform a TLS/SSL handshake
504	SSL_export_keying_material	obtain keying material for application use
505	SSL_extension_supported	custom TLS extension handling
506	SSL_free	free an allocated SSL structure
507	SSL_get0_connection	get a QUIC connection SSL object from a QUIC stream SSL object
508	SSL_get0_group_name	get name of the group that was used for the key agreement of the current TLS session establishment
509	SSL_get0_peer_rpk	raw public key (RFC7250) support
510	SSL_get0_peer_scts	get SCTs received
511	SSL_get_all_async_fds	manage asynchronous operations
512	SSL_get_certificate	retrieve TLS/SSL certificate and private key
513	SSL_get_ciphers	get list of available SSL_CIPHERs
514	SSL_get_client_random	get internal TLS/SSL random values and get/set master key
515	SSL_get_conn_close_info	get information about why a QUIC connection was closed
516	SSL_get_current_cipher	get SSL_CIPHER of a connection
517	SSL_get_default_timeout	get default session timeout value
518	SSL_get_error	obtain result code for TLS/SSL I/O operation
519	SSL_get_event_timeout	determine when an SSL object next needs to have events handled
520	SSL_get_extms_support	extended master secret support
521	SSL_get_fd	get file descriptor linked to an SSL object
522	SSL_get_handshake_rtt	get round trip time for SSL Handshake
523	SSL_get_peer_cert_chain	get the X509 certificate chain of the peer
524	SSL_get_peer_certificate	get the X509 certificate of the peer
525	SSL_get_peer_signature_nid	get TLS message signing types
526	SSL_get_peer_tmp_key	get information about temporary keys used during a handshake
527	SSL_get_psk_identity	get PSK client identity and hint
528	SSL_get_rbio	get BIO linked to an SSL object
529	SSL_get_rpoll_descriptor	obtain information which can be used to determine when network I/O can be performed
530	SSL_get_session	retrieve TLS/SSL session data
531	SSL_get_shared_sigalgs	get supported signature algorithms
532	SSL_get_SSL_CTX	get the SSL_CTX from which an SSL is created
533	SSL_get_stream_id	get QUIC stream ID and stream type information
534	SSL_get_stream_read_state	get QUIC stream state
535	SSL_get_verify_result	get result of peer certificate verification
536	SSL_get_version	get the protocol information of a connection
537	SSL_group_to_name	get name of group
538	SSL_handle_events	advance asynchronous state machine and perform network I/O
539	SSL_in_init	retrieve information about the handshake state machine
540	SSL_inject_net_dgram	inject a datagram as though received from the network
541	SSL_key_update	initiate and obtain information about updating connection keys
542	SSL_library_init	initialize SSL library by registering algorithms
543	SSL_load_client_CA_file	load certificate names
544	SSL_new	create an SSL structure for a connection
545	SSL_new_stream	create a new locally-initiated QUIC stream
546	SSL_pending	check for readable bytes buffered in an SSL object
547	SSL_read_early_data	functions for sending and receiving early data
548	SSL_read	read bytes from a TLS/SSL connection
549	SSL_rstate_string	get textual description of state of an SSL object during read operation
550	SSL_SESSION_free	create, free and manage SSL_SESSION structures
551	SSL_SESSION_get0_cipher	set and retrieve the SSL cipher associated with a session
552	SSL_SESSION_get0_hostname	get and set SNI and ALPN data associated with a session
553	SSL_SESSION_get0_id_context	get and set the SSL ID context associated with a session
554	SSL_SESSION_get0_peer	get details about peer's certificate for a session
555	SSL_SESSION_get_compress_id	get details about the compression associated with a session
556	SSL_SESSION_get_protocol_version	get and set the session protocol version
557	SSL_SESSION_get_time	retrieve and manipulate session time and timeout settings
558	SSL_SESSION_has_ticket	get details about the ticket associated with a session
559	SSL_SESSION_is_resumable	determine whether an SSL_SESSION object can be used for resumption
560	SSL_SESSION_print	printf information about a session
561	SSL_session_reused	query whether a reused session was negotiated during handshake
562	SSL_SESSION_set1_id	get and set the SSL session ID
563	SSL_set1_host	SSL server verification parameters
564	SSL_set1_initial_peer_addr	set the initial peer address for a QUIC connection
565	SSL_set1_server_cert_type	certificate type (RFC7250) support
566	SSL_set_async_callback	manage asynchronous operations
567	SSL_set_bio	connect the SSL object with a BIO
568	SSL_set_blocking_mode	configure blocking mode for a QUIC SSL object
569	SSL_set_connect_state	functions for manipulating and examining the client or server mode of an SSL object
570	SSL_set_default_stream_mode	manage the default stream for a QUIC connection
571	SSL_set_fd	connect the SSL object with a file descriptor
572	SSL_set_incoming_stream_policy	manage the QUIC incoming stream policy
573	SSL_set_retry_verify	indicate that certificate verification should be retried
574	SSL_set_session	set a TLS/SSL session to be used during TLS/SSL connect
575	SSL_set_shutdown	manipulate shutdown state of an SSL connection
576	SSL_set_verify_result	override result of peer certificate verification
577	SSL_shutdown	shut down a TLS/SSL or QUIC connection
578	SSL_state_string	get textual description of state of an SSL object
579	SSL_stream_conclude	conclude the sending part of a QUIC stream
580	SSL_stream_reset	reset a QUIC stream
581	SSL_want	obtain state information TLS/SSL I/O operation
582	SSL_write	write bytes to a TLS/SSL connection
583	TS_RESP_CTX_new	Timestamp response context object creation
584	TS_VERIFY_CTX_set_certs	set certificates for TS response verification
585	UI_create_method	user interface method creation and destruction
586	UI_new	user interface
587	UI_STRING	User interface string parsing
588	UI_UTIL_read_pw	user interface utilities
589	X509_add_cert	X509 certificate list addition functions
590	X509_ALGOR_dup	AlgorithmIdentifier functions
591	X509_check_ca	check if given certificate is CA certificate
592	X509_check_host	X.509 certificate matching
593	X509_check_issued	checks if certificate is apparently issued by another certificate
594	X509_check_private_key	check the consistency of a private key with the public key in an X509 certificate or certificate request
595	X509_check_purpose	Check the purpose of a certificate
596	X509_cmp	compare X509 certificates and related values
597	X509_cmp_time	X509 time functions
598	X509_CRL_get0_by_serial	CRL revoked entry utility functions
599	X509_digest	get digest of various objects
600	X509_dup	ASN1 object utilities
601	X509_EXTENSION_set_object	extension utility functions
602	X509_get0_distinguishing_id	get or set the Distinguishing ID for certificate operations
603	X509_get0_notBefore	get or set certificate or CRL dates
604	X509_get0_signature	signature information
605	X509_get0_uids	get certificate unique identifiers
606	X509_get_default_cert_file	retrieve default locations for trusted CA certificates
607	X509_get_extension_flags	retrieve certificate extension data
608	X509_get_pubkey	get or set certificate or certificate request public key
609	X509_get_serialNumber	get or set certificate serial number
610	X509_get_subject_name	get X509_NAME hashes or get and set issuer or subject names
611	X509_get_version	get or set certificate, certificate request or CRL version
612	X509_load_http	certificate and CRL loading functions
613	X509_LOOKUP_hash_dir	Default OpenSSL certificate lookup methods
614	X509_LOOKUP_meth_new	Routines to build up X509_LOOKUP methods
615	X509_LOOKUP	OpenSSL certificate lookup mechanisms
616	X509_NAME_add_entry_by_txt	X509_NAME modification functions
617	X509_NAME_ENTRY_get_object	X509_NAME_ENTRY utility functions
618	X509_NAME_get0_der	get X509_NAME DER encoding
619	X509_NAME_get_index_by_NID	X509_NAME lookup and enumeration functions
620	X509_NAME_print_ex	X509_NAME printing routines
621	X509_new	X509 certificate ASN1 allocation and deallocation functions
622	X509_PUBKEY_new	SubjectPublicKeyInfo public key functions
623	X509_REQ_get_extensions	handle X.509 extension attributes of a CSR
624	X509_SIG_get0	DigestInfo functions
625	X509_sign	sign certificate, certificate request, or CRL signature
626	X509_STORE_add_cert	X509_STORE manipulation
627	X509_STORE_CTX_get_by_subject	X509 and X509_CRL lookup functions
628	X509_STORE_CTX_get_error	get or set certificate verification status information
629	X509_STORE_CTX_new	X509_STORE_CTX initialisation
630	X509_STORE_CTX_set_verify_cb	get and set X509_STORE_CTX components such as verification callback
631	X509_STORE_get0_param	X509_STORE setter and getter functions
632	X509_STORE_new	X509_STORE allocation, freeing and locking functions
633	X509_STORE_set_verify_cb_func	set verification callback
634	X509V3_get_d2i	X509 extension decode and encode functions
635	X509v3_get_ext_by_NID	extension stack utility functions
636	X509V3_set_ctx	X.509 v3 extension generation utilities
637	X509_verify_cert	build and verify X509 certificate chain
638	X509_VERIFY_PARAM_set_flags	X509 verification parameters
639	X509_verify	verify certificate, certificate request, or CRL signature

OpenSSL Manual Pages

Section man3 of the OpenSSL Manual Pages

Introduction

Alphabetical Listing

Content