'openssl engine' can now list engine capabilities. The current
[openssl.git] / apps / engine.c
1 /* apps/engine.c -*- mode: C; c-file-style: "eay" -*- */
2 /* Written by Richard Levitte <richard@levitte.org> for the OpenSSL
3  * project 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 #ifdef NO_STDIO
63 #define APPS_WIN16
64 #endif
65 #include "apps.h"
66 #include <openssl/err.h>
67 #include <openssl/engine.h>
68 #include <openssl/ssl.h>
69
70 #undef PROG
71 #define PROG    engine_main
72
73 static char *engine_usage[]={
74 "usage: engine opts [engine ...]\n",
75 " -v          - verbose mode, a textual listing of the engines in OpenSSL\n",
76 #if 0
77 " -c          - for each engine, also list the capabilities\n",
78 #endif
79 " -t          - for each engine, check that they are really available\n",
80 NULL
81 };
82
83 static void identity(void *ptr)
84         {
85         return;
86         }
87
88 static int append_buf(char **buf, char *s, int *size, int step)
89         {
90         int l = strlen(s);
91
92         if (*buf == NULL)
93                 {
94                 *size = step;
95                 *buf = OPENSSL_malloc(*size);
96                 if (*buf == NULL)
97                         return 0;
98                 **buf = '\0';
99                 }
100
101         if (**buf != '\0')
102                 l += 2;         /* ", " */
103
104         if (strlen(*buf) + strlen(s) >= *size)
105                 {
106                 *size += step;
107                 *buf = OPENSSL_realloc(*buf, *size);
108                 }
109
110         if (*buf == NULL)
111                 return 0;
112
113         if (**buf != '\0')
114                 strcat(*buf, ", ");
115         strcat(*buf, s);
116
117         return 1;
118         }
119
120 int MAIN(int, char **);
121
122 int MAIN(int argc, char **argv)
123         {
124         int ret=1,i;
125         char **pp;
126         int verbose=0, list_cap=0, test_avail=0;
127         ENGINE *e;
128         STACK *engines = sk_new_null();
129         int badops=0;
130         BIO *bio_out=NULL;
131
132         apps_startup();
133         SSL_load_error_strings();
134
135         if (bio_err == NULL)
136                 bio_err=BIO_new_fp(stderr,BIO_NOCLOSE);
137         bio_out=BIO_new_fp(stdout,BIO_NOCLOSE);
138 #ifdef VMS
139         {
140         BIO *tmpbio = BIO_new(BIO_f_linebuffer());
141         bio_out = BIO_push(tmpbio, bio_out);
142         }
143 #endif
144
145         argc--;
146         argv++;
147         while (argc >= 1)
148                 {
149                 if (strcmp(*argv,"-v") == 0)
150                         verbose=1;
151                 else if (strcmp(*argv,"-c") == 0)
152                         list_cap=1;
153                 else if (strcmp(*argv,"-t") == 0)
154                         test_avail=1;
155                 else if ((strncmp(*argv,"-h",2) == 0) ||
156                          (strcmp(*argv,"-?") == 0))
157                         {
158                         badops=1;
159                         break;
160                         }
161                 else
162                         {
163                         sk_push(engines,*argv);
164                         }
165                 argc--;
166                 argv++;
167                 }
168
169         if (badops)
170                 {
171                 for (pp=engine_usage; (*pp != NULL); pp++)
172                         BIO_printf(bio_err,"%s",*pp);
173                 goto end;
174                 }
175
176         if (sk_num(engines) == 0)
177                 {
178                 for(e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e))
179                         {
180                         sk_push(engines,(char *)ENGINE_get_id(e));
181                         }
182                 }
183
184         for (i=0; i<sk_num(engines); i++)
185                 {
186                 const char *id = sk_value(engines,i);
187                 if ((e = ENGINE_by_id(id)) != NULL)
188                         {
189                         const char *name = ENGINE_get_name(e);
190                         BIO_printf(bio_out, "%s (%s)", name, id);
191                         if (list_cap || test_avail)
192                                 BIO_printf(bio_out, ":");
193                         if (test_avail)
194                                 {
195                                 if (ENGINE_init(e))
196                                         {
197                                         BIO_printf(bio_out, " available");
198                                         ENGINE_finish(e);
199                                         }
200                                 else
201                                         {
202                                         BIO_printf(bio_out, " unavailable");
203                                         ERR_clear_error();
204                                         }
205                                 }
206                         if (list_cap)
207                                 {
208                                 int cap_size = 256;
209                                 char *cap_buf = NULL;
210
211                                 if (ENGINE_get_RSA(e) != NULL
212                                         && !append_buf(&cap_buf, "RSA",
213                                                 &cap_size, 256))
214                                         goto end;
215                                 if (ENGINE_get_DSA(e) != NULL
216                                         && !append_buf(&cap_buf, "DSA",
217                                                 &cap_size, 256))
218                                         goto end;
219                                 if (ENGINE_get_DH(e) != NULL
220                                         && !append_buf(&cap_buf, "DH",
221                                                 &cap_size, 256))
222                                         goto end;
223                                 if (ENGINE_get_RAND(e) != NULL
224                                         && !append_buf(&cap_buf, "RAND",
225                                                 &cap_size, 256))
226                                         goto end;
227
228                                 if (*cap_buf != '\0')
229                                         BIO_printf(bio_out, " [%s]", cap_buf);
230
231                                 OPENSSL_free(cap_buf);
232                                 }
233                         BIO_printf(bio_out, "\n");
234                         }
235                 else
236                         ERR_print_errors(bio_err);
237                 }
238
239         ret=0;
240 end:
241         ERR_print_errors(bio_err);
242         sk_pop_free(engines, identity);
243         if (bio_out != NULL) BIO_free_all(bio_out);
244         EXIT(ret);
245         }