[thirdparty/openssl.git] / demos / README.txt

OpenSSL Demonstration Applications

This folder contains source code that demonstrates the proper use of the OpenSSL
library API.

bio:                   Demonstration of a simple TLS client and server

certs:                 Demonstration of creating certs, using OCSP

cipher:
aesgcm.c               Demonstration of symmetric cipher GCM mode encrypt/decrypt
aesccm.c               Demonstration of symmetric cipher CCM mode encrypt/decrypt
ariacbc.c              Demonstration of symmetric cipher CBC mode encrypt/decrypt

cms:

digest:
EVP_MD_demo.c          Compute a digest from multiple buffers
EVP_MD_stdin.c         Compute a digest with data read from stdin
EVP_MD_xof.c           Compute a digest using the SHAKE256 XOF
EVP_f_md.c             Compute a digest using BIO and EVP_f_md

encrypt:
rsa_encrypt.c          Encrypt and decrypt data using an RSA keypair.

encode:
rsa_encode.c           Encode and decode PEM-encoded RSA keys

kdf:
hkdf.c                 Demonstration of HMAC based key derivation
pbkdf2.c               Demonstration of PBKDF2 password based key derivation
scrypt.c               Demonstration of SCRYPT password based key derivation

mac:
gmac.c                 Demonstration of GMAC message authentication
poly1305.c             Demonstration of Poly1305-AES message authentication
siphash.c              Demonstration of SIPHASH message authentication

pkey:
EVP_PKEY_EC_keygen.c           Generate an EC key.
EVP_PKEY_RSA_keygen.c          Generate an RSA key.
EVP_PKEY_DSA_keygen.c          Generate a DSA key.
EVP_PKEY_DSA_paramgen.c        Generate a DSA param key.
EVP_PKEY_DSA_paramvalidate.c   Validate a DSA param key.
EVP_PKEY_DSA_paramfromdata.c   Load a DSA param key using raw data.

smime:

pkcs12:
pkread.c               Print out a description of a PKCS12 file.
pkwrite.c              Add a password to an existing PKCS12 file.

signature:
EVP_Signature_demo.c   Compute and verify a signature from multiple buffers
rsa_pss_direct.c       Compute and verify an RSA-PSS signature from a hash
rsa_pss_hash.c         Compute and verify an RSA-PSS signature over a buffer

sslecho:
main.c                 Simple SSL echo client/server.
Commit	Line	Data
29ce1066	1	OpenSSL Demonstration Applications
7ebf7674	2
29ce1066 PN	3	This folder contains source code that demonstrates the proper use of the OpenSSL
29ce1066 PN	4	library API.
7ebf7674	5
3068a183	6	bio: Demonstration of a simple TLS client and server
d02b48c6	7
8cf78d63	8	certs: Demonstration of creating certs, using OCSP
29ce1066	9
3068a183 JS	10	cipher:
	11	aesgcm.c Demonstration of symmetric cipher GCM mode encrypt/decrypt
	12	aesccm.c Demonstration of symmetric cipher CCM mode encrypt/decrypt
37697277	13	ariacbc.c Demonstration of symmetric cipher CBC mode encrypt/decrypt
29ce1066 PN	14
	15	cms:
	16
	17	digest:
8cf78d63 SL	18	EVP_MD_demo.c Compute a digest from multiple buffers
8cf78d63 SL	19	EVP_MD_stdin.c Compute a digest with data read from stdin
4c8cdcd1	20	EVP_MD_xof.c Compute a digest using the SHAKE256 XOF
8cf78d63 SL	21	EVP_f_md.c Compute a digest using BIO and EVP_f_md
8cf78d63 SL	22
35530b11 SL	23	encrypt:
	24	rsa_encrypt.c Encrypt and decrypt data using an RSA keypair.
	25
1483b37e HL	26	encode:
	27	rsa_encode.c Encode and decode PEM-encoded RSA keys
	28
a2058604 M	29	kdf:
a2058604 M	30	hkdf.c Demonstration of HMAC based key derivation
b8ffcd87 P	31	pbkdf2.c Demonstration of PBKDF2 password based key derivation
b8ffcd87 P	32	scrypt.c Demonstration of SCRYPT password based key derivation
a2058604	33
58bd45d8 P	34	mac:
58bd45d8 P	35	gmac.c Demonstration of GMAC message authentication
3dafeace	36	poly1305.c Demonstration of Poly1305-AES message authentication
86485398	37	siphash.c Demonstration of SIPHASH message authentication
58bd45d8	38
8cf78d63	39	pkey:
de116410	40	EVP_PKEY_EC_keygen.c Generate an EC key.
	41	EVP_PKEY_RSA_keygen.c Generate an RSA key.
	42	EVP_PKEY_DSA_keygen.c Generate a DSA key.
	43	EVP_PKEY_DSA_paramgen.c Generate a DSA param key.
	44	EVP_PKEY_DSA_paramvalidate.c Validate a DSA param key.
	45	EVP_PKEY_DSA_paramfromdata.c Load a DSA param key using raw data.
29ce1066 PN	46
	47	smime:
	48
8cf78d63 SL	49	pkcs12:
	50	pkread.c Print out a description of a PKCS12 file.
	51	pkwrite.c Add a password to an existing PKCS12 file.
691c9cd1	52
	53	signature:
	54	EVP_Signature_demo.c Compute and verify a signature from multiple buffers
e9492d1c HL	55	rsa_pss_direct.c Compute and verify an RSA-PSS signature from a hash
e9492d1c HL	56	rsa_pss_hash.c Compute and verify an RSA-PSS signature over a buffer
801c638c	57
	58	sslecho:
	59	main.c Simple SSL echo client/server.