Test remote CVS commit...
[openssl.git] / doc / apps.doc
1 The applications
2
3 Ok, where to begin....
4 In the begining, when SSLeay was small (April 1995), there
5 were but few applications, they did happily cohabit in
6 the one bin directory.  Then over time, they did multiply and grow,
7 and they started to look like microsoft software; 500k to print 'hello world'.
8 A new approach was needed.  They were coalessed into one 'Monolithic'
9 application, ssleay.  This one program is composed of many programs that
10 can all be compiled independantly.
11
12 ssleay has 3 modes of operation.
13 1) If the ssleay binaray has the name of one of its component programs, it
14 executes that program and then exits.  This can be achieve by using hard or
15 symbolic links, or failing that, just renaming the binary.
16 2) If the first argument to ssleay is the name of one of the component
17 programs, that program runs that program and then exits.
18 3) If there are no arguments, ssleay enters a 'command' mode.  Each line is
19 interpreted as a program name plus arguments.  After each 'program' is run,
20 ssleay returns to the comand line.
21
22 dgst    - message digests
23 enc     - encryption and base64 encoding
24
25 ans1parse - 'pulls' appart ASN.1 encoded objects like certificates.
26
27 dh      - Diffle-Hellman parameter manipulation.
28 rsa     - RSA manipulations.
29 crl     - Certificate revokion list manipulations
30 x509    - X509 cert fiddles, including signing.
31 pkcs7   - pkcs7 manipulation, only DER versions right now.
32
33 genrsa  - generate an RSA private key.
34 gendh   - Generate a set of Diffle-Hellman parameters.
35 req     - Generate a PKCS#10 object, a certificate request.
36
37 s_client - SSL client program
38 s_server - SSL server program
39 s_time   - A SSL protocol timing program
40 s_mult   - Another SSL server, but it multiplexes
41            connections.
42 s_filter - under development
43
44 errstr  - Convert SSLeay error numbers to strings.
45 ca      - Sign certificate requests, and generate
46           certificate revokion lists
47 crl2pkcs7 - put a crl and certifcates into a pkcs7 object.
48 speed   - Benchmark the ciphers.
49 verify  - Check certificates
50 hashdir - under development
51
52 [ there a now a few more options, play with the program to see what they
53   are ]