[apple/security.git] / SecurityTests / cspxutils / EXAMPLES_README

                        CDSA Sample Code Info
					 last update 4/24/02 dmitch
						  
Introduction
------------
This directory contains three programs which demonstrate how to 
write code using the Common Data Security Architecture (CDSA) 
API.

Building
--------

To build all of the examples, open a Terminal window, cd to the 
CDSA_Examples directory, and type 'make'. If the LOCAL_BUILD_DIR 
environment variable is set, the executables are placed there; 
otherwise they are built in place in the respective directories.

Source code
-----------
There are four directories in this package. Three contain the 
source for three executables themselves - rsatool, dhTest, and 
cryptTool. The fourth is utilLib, which contains a superset of 
the code which the three examples need to link against. The only 
two files in utilLib of interest for the purpose of these example are:

common.c - setup and initialize CSSM and CSP (see cspDlDbStartup())
cspwrap.c - wrapper functions for some of the crypto operations,
like generate key pair (cspGenKeyPair()), encryption
(cspEncrypt()), and decryption (cspDecrypt()). 

See the README files in the respective directories for more 
information.
Commit	Line	Data
d8f41ccd A	1	CDSA Sample Code Info
	2	last update 4/24/02 dmitch
	3
	4	Introduction
	5	------------
	6	This directory contains three programs which demonstrate how to
	7	write code using the Common Data Security Architecture (CDSA)
	8	API.
	9
	10	Building
	11	--------
	12
	13	To build all of the examples, open a Terminal window, cd to the
	14	CDSA_Examples directory, and type 'make'. If the LOCAL_BUILD_DIR
	15	environment variable is set, the executables are placed there;
	16	otherwise they are built in place in the respective directories.
	17
	18	Source code
	19	-----------
	20	There are four directories in this package. Three contain the
	21	source for three executables themselves - rsatool, dhTest, and
	22	cryptTool. The fourth is utilLib, which contains a superset of
	23	the code which the three examples need to link against. The only
	24	two files in utilLib of interest for the purpose of these example are:
	25
	26	common.c - setup and initialize CSSM and CSP (see cspDlDbStartup())
	27	cspwrap.c - wrapper functions for some of the crypto operations,
	28	like generate key pair (cspGenKeyPair()), encryption
	29	(cspEncrypt()), and decryption (cspDecrypt()).
	30
	31	See the README files in the respective directories for more
	32	information.
	33