?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
dmake: do not set MAKEFLAGS=k
[unleashed/tickless.git] / usr / src / cmd / cmd-crypto / pktool / common.c
blob72d6ebca6d186929da028c49087e7981c03f1566
1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 *
21 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
22 */
23
24 /*
25 * This file contains the functions that are shared among
26 * the various services this tool will ultimately provide.
27 * The functions in this file return PKCS#11 CK_RV errors.
28 * Only one session and one login per token is supported
29 * at this time.
30 */
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <ctype.h>
36 #include <sys/types.h>
37 #include <sys/stat.h>
38 #include <fcntl.h>
39 #include <tzfile.h>
40 #include <cryptoutil.h>
41 #include <security/cryptoki.h>
42 #include <kmfapi.h>
43
44 #include "common.h"
45
46 /* Local status variables. */
47 static boolean_t initialized = B_FALSE;
48 static boolean_t session_opened = B_FALSE;
49 static boolean_t logged_in = B_FALSE;
50
51 /* Supporting structures and global variables for getopt_av(). */
52 typedef struct av_opts_s {
53 int shortnm; /* short name character */
54 char *longnm; /* long name string, NOT terminated */
55 int longnm_len; /* length of long name string */
56 boolean_t has_arg; /* takes optional argument */
57 } av_opts;
58 static av_opts *opts_av = NULL;
59 static const char *_save_optstr = NULL;
60 static int _save_numopts = 0;
61
62 int optind_av = 1;
63 char *optarg_av = NULL;
64
65 static void close_sess(CK_SESSION_HANDLE);
66 static void logout_token(CK_SESSION_HANDLE);
67
68 struct oid_table_entry {
69 const KMF_OID *oid;
70 char *name;
71 };
72
73 struct oid_table_entry oid_table[] = {
74 { &KMFOID_ECC_secp112r1, "secp112r1"},
75 { &KMFOID_ECC_secp112r2, "secp112r2"},
76 { &KMFOID_ECC_secp128r1, "secp128r1"},
77 { &KMFOID_ECC_secp128r2, "secp128r2"},
78 { &KMFOID_ECC_secp160k1, "secp160k1"},
79 { &KMFOID_ECC_secp160r1, "secp160r1"},
80 { &KMFOID_ECC_secp160r2, "secp160r2"},
81 { &KMFOID_ECC_secp192k1, "secp192k1"},
82 { &KMFOID_ECC_secp192r1, "secp192r1"},
83 { &KMFOID_ECC_secp224k1, "secp224k1"},
84 { &KMFOID_ECC_secp224r1, "secp224r1"},
85 { &KMFOID_ECC_secp256k1, "secp256k1"},
86 { &KMFOID_ECC_secp256r1, "secp256r1"},
87 { &KMFOID_ECC_secp384r1, "secp384r1"},
88 { &KMFOID_ECC_secp521r1, "secp521r1"},
89 { &KMFOID_ECC_sect113r1, "sect113r1"},
90 { &KMFOID_ECC_sect113r2, "sect113r2"},
91 { &KMFOID_ECC_sect131r1, "sect131r1"},
92 { &KMFOID_ECC_sect131r2, "sect131r2"},
93 { &KMFOID_ECC_sect163k1, "sect163k1"},
94 { &KMFOID_ECC_sect163r1, "sect163r1"},
95 { &KMFOID_ECC_sect163r2, "sect163r2"},
96 { &KMFOID_ECC_sect193r1, "sect193r1"},
97 { &KMFOID_ECC_sect193r2, "sect193r2"},
98 { &KMFOID_ECC_sect233k1, "sect233k1"},
99 { &KMFOID_ECC_sect233r1, "sect233r1"},
100 { &KMFOID_ECC_sect239k1, "sect239k1"},
101 { &KMFOID_ECC_sect283k1, "sect283k1"},
102 { &KMFOID_ECC_sect283r1, "sect283r1"},
103 { &KMFOID_ECC_sect409k1, "sect409k1"},
104 { &KMFOID_ECC_sect409r1, "sect409r1"},
105 { &KMFOID_ECC_sect571k1, "sect571k1"},
106 { &KMFOID_ECC_sect571r1, "sect571r1"},
107 { &KMFOID_ECC_c2pnb163v1, "c2pnb163v1"},
108 { &KMFOID_ECC_c2pnb163v2, "c2pnb163v2"},
109 { &KMFOID_ECC_c2pnb163v3, "c2pnb163v3"},
110 { &KMFOID_ECC_c2pnb176v1, "c2pnb176v1"},
111 { &KMFOID_ECC_c2tnb191v1, "c2tnb191v1"},
112 { &KMFOID_ECC_c2tnb191v2, "c2tnb191v2"},
113 { &KMFOID_ECC_c2tnb191v3, "c2tnb191v3"},
114 { &KMFOID_ECC_c2pnb208w1, "c2pnb208w1"},
115 { &KMFOID_ECC_c2tnb239v1, "c2tnb239v1"},
116 { &KMFOID_ECC_c2tnb239v2, "c2tnb239v2"},
117 { &KMFOID_ECC_c2tnb239v3, "c2tnb239v3"},
118 { &KMFOID_ECC_c2pnb272w1, "c2pnb272w1"},
119 { &KMFOID_ECC_c2pnb304w1, "c2pnb304w1"},
120 { &KMFOID_ECC_c2tnb359v1, "c2tnb359v1"},
121 { &KMFOID_ECC_c2pnb368w1, "c2pnb368w1"},
122 { &KMFOID_ECC_c2tnb431r1, "c2tnb431r1"},
123 { &KMFOID_ECC_prime192v2, "prime192v2"},
124 { &KMFOID_ECC_prime192v3, "prime192v3"},
125 { &KMFOID_MD5, "md5"},
126 { &KMFOID_SHA1, "sha1"},
127 { &KMFOID_SHA256, "sha256"},
128 { &KMFOID_SHA384, "sha384"},
129 { &KMFOID_SHA512, "sha512"}
130 };
131 int number_of_oids = sizeof (oid_table) / sizeof (struct oid_table_entry);
132 #define number_of_curves (number_of_oids - 5)
133
134 /*
135 * Perform PKCS#11 setup here. Currently only C_Initialize is required,
136 * along with setting/resetting state variables.
137 */
138 static CK_RV
139 init_pkcs11(void)
140 {
141 CK_RV rv = CKR_OK;
142
143 /* If C_Initialize() already called, nothing to do here. */
144 if (initialized == B_TRUE)
145 return (CKR_OK);
146
147 /* Reset state variables because C_Initialize() not yet done. */
148 session_opened = B_FALSE;
149 logged_in = B_FALSE;
150
151 /* Initialize PKCS#11 library. */
152 if ((rv = C_Initialize(NULL_PTR)) != CKR_OK &&
153 rv != CKR_CRYPTOKI_ALREADY_INITIALIZED) {
154 return (rv);
155 }
156
157 initialized = B_TRUE;
158 return (CKR_OK);
159 }
160
161 /*
162 * Finalize PKCS#11 library and reset state variables. Open sessions,
163 * if any, are closed, and thereby any logins are logged out also.
164 */
165 void
166 final_pk11(CK_SESSION_HANDLE sess)
167 {
168
169 /* If the library wasn't initialized, nothing to do here. */
170 if (!initialized)
171 return;
172
173 /* Make sure the sesion is closed first. */
174 close_sess(sess);
175
176 (void) C_Finalize(NULL);
177 initialized = B_FALSE;
178 }
179
180 /*
181 * Close PKCS#11 session and reset state variables. Any logins are
182 * logged out.
183 */
184 static void
185 close_sess(CK_SESSION_HANDLE sess)
186 {
187
188 if (sess == 0) {
189 return;
190 }
191
192 /* If session is already closed, nothing to do here. */
193 if (!session_opened)
194 return;
195
196 /* Make sure user is logged out of token. */
197 logout_token(sess);
198
199 (void) C_CloseSession(sess);
200 session_opened = B_FALSE;
201 }
202
203 /*
204 * Log user out of token and reset status variable.
205 */
206 static void
207 logout_token(CK_SESSION_HANDLE sess)
208 {
209
210 if (sess == 0) {
211 return;
212 }
213
214 /* If already logged out, nothing to do here. */
215 if (!logged_in)
216 return;
217
218 (void) C_Logout(sess);
219 logged_in = B_FALSE;
220 }
221
222 /*
223 * Gets PIN from user. Caller needs to free the returned PIN when done.
224 * If two prompts are given, the PIN is confirmed with second prompt.
225 * Note that getphassphrase() may return data in static memory area.
226 */
227 CK_RV
228 get_pin(char *prompt1, char *prompt2, CK_UTF8CHAR_PTR *pin, CK_ULONG *pinlen)
229 {
230 char *save_phrase, *phrase1, *phrase2;
231
232 /* Prompt user for a PIN. */
233 if (prompt1 == NULL) {
234 return (CKR_ARGUMENTS_BAD);
235 }
236 if ((phrase1 = getpassphrase(prompt1)) == NULL) {
237 return (CKR_FUNCTION_FAILED);
238 }
239
240 /* Duplicate 1st PIN in separate chunk of memory. */
241 if ((save_phrase = strdup(phrase1)) == NULL)
242 return (CKR_HOST_MEMORY);
243
244 /* If second prompt given, PIN confirmation is requested. */
245 if (prompt2 != NULL) {
246 if ((phrase2 = getpassphrase(prompt2)) == NULL) {
247 free(save_phrase);
248 return (CKR_FUNCTION_FAILED);
249 }
250 if (strcmp(save_phrase, phrase2) != 0) {
251 free(save_phrase);
252 return (CKR_PIN_INCORRECT);
253 }
254 }
255
256 *pin = (CK_UTF8CHAR_PTR)save_phrase;
257 *pinlen = strlen(save_phrase);
258 return (CKR_OK);
259 }
260
261 int
262 yn_to_int(char *ynstr)
263 {
264 char *y = gettext("yes");
265 char *n = gettext("no");
266 if (ynstr == NULL)
267 return (-1);
268
269 if (strncasecmp(ynstr, y, 1) == 0)
270 return (1);
271 else if (strncasecmp(ynstr, n, 1) == 0)
272 return (0);
273 else
274 return (-1);
275 }
276
277 /*
278 * Gets yes/no response from user. If either no prompt is supplied, a
279 * default prompt is used. If not message for invalid input is supplied,
280 * a default will not be provided. If the user provides no response,
281 * the input default B_TRUE == yes, B_FALSE == no is returned.
282 * Otherwise, B_TRUE is returned for yes, and B_FALSE for no.
283 */
284 boolean_t
285 yesno(char *prompt, char *invalid, boolean_t dflt)
286 {
287 char *response, buf[1024];
288 int ans;
289
290 if (prompt == NULL)
291 prompt = gettext("Enter (y)es or (n)o? ");
292
293 for (;;) {
294 /* Prompt user. */
295 (void) printf("%s", prompt);
296 (void) fflush(stdout);
297
298 /* Get the response. */
299 if ((response = fgets(buf, sizeof (buf), stdin)) == NULL)
300 break; /* go to default response */
301
302 /* Skip any leading white space. */
303 while (isspace(*response))
304 response++;
305 if (*response == '\0')
306 break; /* go to default response */
307
308 ans = yn_to_int(response);
309 if (ans == 1)
310 return (B_TRUE);
311 else if (ans == 0)
312 return (B_FALSE);
313
314 /* Indicate invalid input, and try again. */
315 if (invalid != NULL)
316 (void) printf("%s", invalid);
317 }
318 return (dflt);
319 }
320
321 /*
322 * Gets the list of slots which have tokens in them. Keeps adjusting
323 * the size of the slot list buffer until the call is successful or an
324 * irrecoverable error occurs.
325 */
326 CK_RV
327 get_token_slots(CK_SLOT_ID_PTR *slot_list, CK_ULONG *slot_count)
328 {
329 CK_ULONG tmp_count = 0;
330 CK_SLOT_ID_PTR tmp_list = NULL_PTR, tmp2_list = NULL_PTR;
331 int rv = CKR_OK;
332
333 if (!initialized)
334 if ((rv = init_pkcs11()) != CKR_OK)
335 return (rv);
336
337 /*
338 * Get the slot count first because we don't know how many
339 * slots there are and how many of those slots even have tokens.
340 * Don't specify an arbitrary buffer size for the slot list;
341 * it may be too small (see section 11.5 of PKCS#11 spec).
342 * Also select only those slots that have tokens in them,
343 * because this tool has no need to know about empty slots.
344 */
345 if ((rv = C_GetSlotList(1, NULL_PTR, &tmp_count)) != CKR_OK)
346 return (rv);
347
348 if (tmp_count == 0) {
349 *slot_list = NULL_PTR;
350 *slot_count = 0;
351 return (CKR_OK);
352 }
353
354 /* Allocate initial space for the slot list. */
355 if ((tmp_list = (CK_SLOT_ID_PTR) malloc(tmp_count *
356 sizeof (CK_SLOT_ID))) == NULL)
357 return (CKR_HOST_MEMORY);
358
359 /* Then get the slot list itself. */
360 for (;;) {
361 if ((rv = C_GetSlotList(1, tmp_list, &tmp_count)) == CKR_OK) {
362 *slot_list = tmp_list;
363 *slot_count = tmp_count;
364 break;
365 }
366
367 if (rv != CKR_BUFFER_TOO_SMALL) {
368 free(tmp_list);
369 break;
370 }
371
372 /* If the number of slots grew, try again. */
373 if ((tmp2_list = reallocarray(tmp_list, tmp_count,
374 sizeof (CK_SLOT_ID))) == NULL) {
375 free(tmp_list);
376 rv = CKR_HOST_MEMORY;
377 break;
378 }
379 tmp_list = tmp2_list;
380 }
381
382 return (rv);
383 }
384
385 /*
386 * Breaks out the getopt-style option string into a structure that can be
387 * traversed later for calls to getopt_av(). Option string is NOT altered,
388 * but the struct fields point to locations within option string.
389 */
390 static int
391 populate_opts(char *optstring)
392 {
393 int i;
394 av_opts *temp;
395 char *marker;
396
397 if (optstring == NULL || *optstring == '\0')
398 return (0);
399
400 /*
401 * This tries to imitate getopt(3c) Each option must conform to:
402 * <short name char> [ ':' ] [ '(' <long name string> ')' ]
403 * If long name is missing, the short name is used for long name.
404 */
405 for (i = 0; *optstring != '\0'; i++) {
406 if ((temp = (av_opts *)((i == 0) ? malloc(sizeof (av_opts)) :
407 reallocarray(opts_av, i + 1, sizeof (av_opts)))) == NULL) {
408 free(opts_av);
409 opts_av = NULL;
410 return (0);
411 } else {
412 opts_av = (av_opts *)temp;
413 }
414
415 (void) memset(&opts_av[i], 0, sizeof (av_opts));
416 marker = optstring; /* may need optstring later */
417
418 opts_av[i].shortnm = *marker++; /* set short name */
419
420 if (*marker == ':') { /* check for opt arg */
421 marker++;
422 opts_av[i].has_arg = B_TRUE;
423 }
424
425 if (*marker == '(') { /* check and set long name */
426 marker++;
427 opts_av[i].longnm = marker;
428 opts_av[i].longnm_len = strcspn(marker, ")");
429 optstring = marker + opts_av[i].longnm_len + 1;
430 } else {
431 /* use short name option character */
432 opts_av[i].longnm = optstring;
433 opts_av[i].longnm_len = 1;
434 optstring = marker;
435 }
436 }
437
438 return (i);
439 }
440
441 /*
442 * getopt_av() is very similar to getopt(3c) in that the takes an option
443 * string, compares command line arguments for matches, and returns a single
444 * letter option when a match is found. However, getopt_av() differs from
445 * getopt(3c) by requiring that only longname options and values be found
446 * on the command line and all leading dashes are omitted. In other words,
447 * it tries to enforce only longname "option=value" arguments on the command
448 * line. Boolean options are not allowed either.
449 */
450 int
451 getopt_av(int argc, char * const *argv, const char *optstring)
452 {
453 int i;
454 int len;
455 char *cur_option;
456
457 if (optind_av >= argc)
458 return (EOF);
459
460 /* First time or when optstring changes from previous one */
461 if (_save_optstr != optstring) {
462 free(opts_av);
463 opts_av = NULL;
464 _save_optstr = optstring;
465 _save_numopts = populate_opts((char *)optstring);
466 }
467
468 for (i = 0; i < _save_numopts; i++) {
469 cur_option = argv[optind_av];
470
471 if (strcmp(cur_option, "--") == 0) {
472 optind_av++;
473 break;
474 }
475
476 if (cur_option[0] == '-' && strlen(cur_option) == 2) {
477 len = 1;
478 cur_option++; /* remove "-" */
479 } else {
480 len = strcspn(cur_option, "=");
481 }
482
483 if (len == opts_av[i].longnm_len && strncmp(cur_option,
484 opts_av[i].longnm, opts_av[i].longnm_len) == 0) {
485 /* matched */
486 if (!opts_av[i].has_arg) {
487 optind_av++;
488 return (opts_av[i].shortnm);
489 }
490
491 /* needs optarg */
492 if (cur_option[len] == '=') {
493 optarg_av = &(cur_option[len+1]);
494 optind_av++;
495 return (opts_av[i].shortnm);
496 }
497
498 optarg_av = NULL;
499 optind_av++;
500 return ((int)'?');
501 }
502 }
503
504 return (EOF);
505 }
506
507 KMF_KEYSTORE_TYPE
508 KS2Int(char *keystore_str)
509 {
510 if (keystore_str == NULL)
511 return (0);
512 if (strcasecmp(keystore_str, "pkcs11") == 0)
513 return (KMF_KEYSTORE_PK11TOKEN);
514 else if (strcasecmp(keystore_str, "nss") == 0)
515 return (KMF_KEYSTORE_NSS);
516 else if (strcasecmp(keystore_str, "file") == 0)
517 return (KMF_KEYSTORE_OPENSSL);
518 else
519 return (0);
520 }
521
522 /*
523 * compare_oids
524 * return 1 if equal
525 */
526 boolean_t
527 compare_oids(KMF_OID *oid1, const KMF_OID *oid2)
528 {
529 return ((oid1->Length == oid2->Length) &&
530 !memcmp(oid1->Data, oid2->Data, oid1->Length));
531 }
532
533 int
534 Str2KeyType(char *algm, KMF_OID *hashoid, KMF_KEY_ALG *ktype,
535 KMF_ALGORITHM_INDEX *sigAlg)
536 {
537 if (algm == NULL) {
538 /* Default to SHA1+RSA */
539 *sigAlg = KMF_ALGID_SHA1WithRSA;
540 *ktype = KMF_RSA;
541 } else if (strcasecmp(algm, "DSA") == 0) {
542 if (hashoid == NULL ||
543 compare_oids(hashoid, &KMFOID_SHA1))
544 *sigAlg = KMF_ALGID_SHA1WithDSA;
545 else if (compare_oids(hashoid, &KMFOID_SHA256))
546 *sigAlg = KMF_ALGID_SHA256WithDSA;
547 else
548 return (-1); /* unsupported hash/key combo */
549 *ktype = KMF_DSA;
550 } else if (strcasecmp(algm, "RSA") == 0) {
551 if (hashoid == NULL ||
552 compare_oids(hashoid, &KMFOID_SHA1))
553 *sigAlg = KMF_ALGID_SHA1WithRSA;
554 else if (compare_oids(hashoid, &KMFOID_SHA256))
555 *sigAlg = KMF_ALGID_SHA256WithRSA;
556 else if (compare_oids(hashoid, &KMFOID_SHA384))
557 *sigAlg = KMF_ALGID_SHA384WithRSA;
558 else if (compare_oids(hashoid, &KMFOID_SHA512))
559 *sigAlg = KMF_ALGID_SHA512WithRSA;
560 else if (compare_oids(hashoid, &KMFOID_MD5))
561 *sigAlg = KMF_ALGID_MD5WithRSA;
562 else
563 return (-1); /* unsupported hash/key combo */
564 *ktype = KMF_RSA;
565 } else if (strcasecmp(algm, "EC") == 0) {
566 /* EC keys may be used with some SHA2 hashes */
567 if (hashoid == NULL ||
568 compare_oids(hashoid, &KMFOID_SHA1))
569 *sigAlg = KMF_ALGID_SHA1WithECDSA;
570 else if (compare_oids(hashoid, &KMFOID_SHA256))
571 *sigAlg = KMF_ALGID_SHA256WithECDSA;
572 else if (compare_oids(hashoid, &KMFOID_SHA384))
573 *sigAlg = KMF_ALGID_SHA384WithECDSA;
574 else if (compare_oids(hashoid, &KMFOID_SHA512))
575 *sigAlg = KMF_ALGID_SHA512WithECDSA;
576 else
577 return (-1); /* unsupported hash/key combo */
578
579 *ktype = KMF_ECDSA;
580 } else {
581 return (-1);
582 }
583 return (0);
584 }
585
586 int
587 Str2SymKeyType(char *algm, KMF_KEY_ALG *ktype)
588 {
589 if (algm == NULL)
590 *ktype = KMF_AES;
591 else if (strcasecmp(algm, "aes") == 0)
592 *ktype = KMF_AES;
593 else if (strcasecmp(algm, "arcfour") == 0)
594 *ktype = KMF_RC4;
595 else if (strcasecmp(algm, "des") == 0)
596 *ktype = KMF_DES;
597 else if (strcasecmp(algm, "3des") == 0)
598 *ktype = KMF_DES3;
599 else if (strcasecmp(algm, "generic") == 0)
600 *ktype = KMF_GENERIC_SECRET;
601 else
602 return (-1);
603
604 return (0);
605 }
606
607 int
608 Str2Lifetime(char *ltimestr, uint32_t *ltime)
609 {
610 int num;
611 char timetok[6];
612
613 if (ltimestr == NULL || strlen(ltimestr) == 0) {
614 /* default to 1 year lifetime */
615 *ltime = SECSPERDAY * DAYSPERNYEAR;
616 return (0);
617 }
618
619 (void) memset(timetok, 0, sizeof (timetok));
620 if (sscanf(ltimestr, "%d-%06s", &num, timetok) != 2)
621 return (-1);
622
623 if (strcasecmp(timetok, "day") == 0||
624 strcasecmp(timetok, "days") == 0) {
625 *ltime = num * SECSPERDAY;
626 } else if (strcasecmp(timetok, "hour") == 0||
627 strcasecmp(timetok, "hours") == 0) {
628 *ltime = num * SECSPERHOUR;
629 } else if (strcasecmp(timetok, "year") == 0 ||
630 strcasecmp(timetok, "years") == 0) {
631 *ltime = num * SECSPERDAY * DAYSPERNYEAR;
632 } else {
633 *ltime = 0;
634 return (-1);
635 }
636
637 return (0);
638 }
639
640 int
641 OT2Int(char *objclass)
642 {
643 char *c = NULL;
644 int retval = 0;
645
646 if (objclass == NULL)
647 return (-1);
648
649 c = strchr(objclass, ':');
650 if (c != NULL) {
651 if (strcasecmp(c, ":private") == 0)
652 retval = PK_PRIVATE_OBJ;
653 else if (strcasecmp(c, ":public") == 0)
654 retval = PK_PUBLIC_OBJ;
655 else if (strcasecmp(c, ":both") == 0)
656 retval = PK_PRIVATE_OBJ | PK_PUBLIC_OBJ;
657 else /* unrecognized option */
658 return (-1);
659
660 *c = '\0';
661 }
662
663 if (strcasecmp(objclass, "public") == 0) {
664 if (retval)
665 return (-1);
666 return (retval | PK_PUBLIC_OBJ | PK_CERT_OBJ | PK_PUBKEY_OBJ);
667 } else if (strcasecmp(objclass, "private") == 0) {
668 if (retval)
669 return (-1);
670 return (retval | PK_PRIKEY_OBJ | PK_PRIVATE_OBJ);
671 } else if (strcasecmp(objclass, "both") == 0) {
672 if (retval)
673 return (-1);
674 return (PK_KEY_OBJ | PK_PUBLIC_OBJ | PK_PRIVATE_OBJ);
675 } else if (strcasecmp(objclass, "cert") == 0) {
676 return (retval | PK_CERT_OBJ);
677 } else if (strcasecmp(objclass, "key") == 0) {
678 if (retval == 0) /* return all keys */
679 return (retval | PK_KEY_OBJ);
680 else if (retval == (PK_PRIVATE_OBJ | PK_PUBLIC_OBJ))
681 /* return all keys */
682 return (retval | PK_KEY_OBJ);
683 else if (retval & PK_PUBLIC_OBJ)
684 /* Only return public keys */
685 return (retval | PK_PUBKEY_OBJ);
686 else if (retval & PK_PRIVATE_OBJ)
687 /* Only return private keys */
688 return (retval | PK_PRIKEY_OBJ);
689 } else if (strcasecmp(objclass, "crl") == 0) {
690 if (retval)
691 return (-1);
692 return (retval | PK_CRL_OBJ);
693 }
694
695 if (retval == 0) /* No matches found */
696 retval = -1;
697 return (retval);
698 }
699
700 KMF_ENCODE_FORMAT
701 Str2Format(char *formstr)
702 {
703 if (formstr == NULL || strcasecmp(formstr, "der") == 0)
704 return (KMF_FORMAT_ASN1);
705 if (strcasecmp(formstr, "pem") == 0)
706 return (KMF_FORMAT_PEM);
707 if (strcasecmp(formstr, "pkcs12") == 0)
708 return (KMF_FORMAT_PKCS12);
709 if (strcasecmp(formstr, "raw") == 0)
710 return (KMF_FORMAT_RAWKEY);
711
712 return (KMF_FORMAT_UNDEF);
713 }
714
715 KMF_RETURN
716 select_token(void *kmfhandle, char *token, int readonly)
717 {
718 KMF_ATTRIBUTE attlist[10];
719 int i = 0;
720 KMF_KEYSTORE_TYPE kstype = KMF_KEYSTORE_PK11TOKEN;
721 KMF_RETURN rv = KMF_OK;
722
723 if (token == NULL)
724 return (KMF_ERR_BAD_PARAMETER);
725
726 kmf_set_attr_at_index(attlist, i,
727 KMF_KEYSTORE_TYPE_ATTR, &kstype,
728 sizeof (kstype));
729 i++;
730
731 if (token) {
732 kmf_set_attr_at_index(attlist, i,
733 KMF_TOKEN_LABEL_ATTR, token,
734 strlen(token));
735 i++;
736 }
737
738 kmf_set_attr_at_index(attlist, i,
739 KMF_READONLY_ATTR, &readonly,
740 sizeof (readonly));
741 i++;
742
743 rv = kmf_configure_keystore(kmfhandle, i, attlist);
744 if (rv == KMF_ERR_TOKEN_SELECTED)
745 rv = KMF_OK;
746 return (rv);
747 }
748
749 KMF_RETURN
750 configure_nss(void *kmfhandle, char *dir, char *prefix)
751 {
752 KMF_ATTRIBUTE attlist[10];
753 int i = 0;
754 KMF_KEYSTORE_TYPE kstype = KMF_KEYSTORE_NSS;
755 KMF_RETURN rv = KMF_OK;
756
757 kmf_set_attr_at_index(attlist, i,
758 KMF_KEYSTORE_TYPE_ATTR, &kstype,
759 sizeof (kstype));
760 i++;
761
762 if (dir) {
763 kmf_set_attr_at_index(attlist, i,
764 KMF_DIRPATH_ATTR, dir,
765 strlen(dir));
766 i++;
767 }
768
769 if (prefix) {
770 kmf_set_attr_at_index(attlist, i,
771 KMF_CERTPREFIX_ATTR, prefix,
772 strlen(prefix));
773 i++;
774
775 kmf_set_attr_at_index(attlist, i,
776 KMF_KEYPREFIX_ATTR, prefix,
777 strlen(prefix));
778 i++;
779 }
780
781 rv = kmf_configure_keystore(kmfhandle, i, attlist);
782 if (rv == KMF_KEYSTORE_ALREADY_INITIALIZED)
783 rv = KMF_OK;
784
785 return (rv);
786 }
787
788 KMF_RETURN
789 get_pk12_password(KMF_CREDENTIAL *cred)
790 {
791 KMF_RETURN rv = KMF_OK;
792 char prompt[1024];
793
794 /*
795 * Get the password to use for the PK12 encryption.
796 */
797 (void) strlcpy(prompt,
798 gettext("Enter password to use for "
799 "accessing the PKCS12 file: "), sizeof (prompt));
800
801 if (get_pin(prompt, NULL, (uchar_t **)&cred->cred,
802 (ulong_t *)&cred->credlen) != CKR_OK) {
803 cred->cred = NULL;
804 cred->credlen = 0;
805 }
806
807 return (rv);
808 }
809
810 #define FILENAME_PROMPT gettext("Filename:")
811 #define FILENAME_MINLEN 1
812 #define FILENAME_MAXLEN MAXPATHLEN
813
814 #define COUNTRY_PROMPT gettext("Country Name (2 letter code) [US]:")
815 #define STATE_PROMPT gettext("State or Province Name (full name) " \
816 "[Some-State]:")
817 #define LOCALITY_PROMPT gettext("Locality Name (eg, city) []:")
818 #define ORG_PROMPT gettext("Organization Name (eg, company) []:")
819 #define UNIT_PROMPT gettext("Organizational Unit Name (eg, section) []:")
820 #define NAME_PROMPT gettext("Common Name (eg, YOUR name) []:")
821 #define EMAIL_PROMPT gettext("Email Address []:")
822
823 #define SERNO_PROMPT gettext("Serial Number (hex value, example: " \
824 "0x01020304):")
825 #define SERNO_MINLEN 3
826 #define SERNO_MAXLEN 42
827
828 #define LABEL_PROMPT gettext("Enter a label for the certificate:")
829 #define LABEL_MINLEN 1
830 #define LABEL_MAXLEN 1024
831
832 #define COUNTRY_DEFAULT "US"
833 #define STATE_DEFAULT NULL
834 #define INVALID_INPUT gettext("Invalid input; please re-enter ...")
835
836 #define SUBNAMESIZ 1024
837 #define RDN_MIN 1
838 #define RDN_MAX 64
839 #define COUNTRYNAME_MIN 2
840 #define COUNTRYNAME_MAX 2
841
842 static char *
843 get_input_string(char *prompt, char *default_str, int min_len, int max_len)
844 {
845 char buf[1024];
846 char *response = NULL;
847 char *ret = NULL;
848 int len;
849
850 for (;;) {
851 (void) printf("\t%s", prompt);
852 (void) fflush(stdout);
853
854 response = fgets(buf, sizeof (buf), stdin);
855 if (response == NULL) {
856 if (default_str != NULL) {
857 ret = strdup(default_str);
858 }
859 break;
860 }
861
862 /* Skip any leading white space. */
863 while (isspace(*response))
864 response++;
865 if (*response == '\0') {
866 if (default_str != NULL) {
867 ret = strdup(default_str);
868 }
869 break;
870 }
871
872 len = strlen(response);
873 response[len-1] = '\0'; /* get rid of "LF" */
874 len--;
875 if (len >= min_len && len <= max_len) {
876 ret = strdup(response);
877 break;
878 }
879
880 (void) printf("%s\n", INVALID_INPUT);
881
882 }
883
884 return (ret);
885 }
886
887 int
888 get_filename(char *txt, char **result)
889 {
890 char prompt[1024];
891 char *fname = NULL;
892
893 (void) snprintf(prompt, sizeof (prompt),
894 gettext("Enter filename for the %s: "),
895 txt);
896 fname = get_input_string(prompt, NULL,
897 FILENAME_MINLEN, FILENAME_MAXLEN);
898 *result = fname;
899 return (0);
900 }
901
902 int
903 get_certlabel(char **result)
904 {
905 char *label = NULL;
906
907 label = get_input_string(LABEL_PROMPT, NULL,
908 LABEL_MINLEN, LABEL_MAXLEN);
909 *result = label;
910 return (0);
911 }
912
913 int
914 get_serial(char **result)
915 {
916 char *serial = NULL;
917
918 serial = get_input_string(SERNO_PROMPT, NULL, SERNO_MINLEN,
919 SERNO_MAXLEN);
920
921 *result = serial;
922 return (0);
923 }
924
925 int
926 get_subname(char **result)
927 {
928 char *country = NULL;
929 char *state = NULL;
930 char *locality = NULL;
931 char *org = NULL;
932 char *unit = NULL;
933 char *name = NULL;
934 char *email = NULL;
935 char *subname = NULL;
936
937 (void) printf("Entering following fields for subject (a DN) ...\n");
938 country = get_input_string(COUNTRY_PROMPT, COUNTRY_DEFAULT,
939 COUNTRYNAME_MIN, COUNTRYNAME_MAX);
940 if (country == NULL)
941 return (-1);
942
943 state = get_input_string(STATE_PROMPT, STATE_DEFAULT,
944 RDN_MIN, RDN_MAX);
945
946 locality = get_input_string(LOCALITY_PROMPT, NULL, RDN_MIN, RDN_MAX);
947 org = get_input_string(ORG_PROMPT, NULL, RDN_MIN, RDN_MAX);
948 unit = get_input_string(UNIT_PROMPT, NULL, RDN_MIN, RDN_MAX);
949 name = get_input_string(NAME_PROMPT, NULL, RDN_MIN, RDN_MAX);
950 email = get_input_string(EMAIL_PROMPT, NULL, RDN_MIN, RDN_MAX);
951
952 /* Now create a subject name from the input strings */
953 if ((subname = malloc(SUBNAMESIZ)) == NULL)
954 goto out;
955
956 (void) memset(subname, 0, SUBNAMESIZ);
957 (void) strlcpy(subname, "C=", SUBNAMESIZ);
958 (void) strlcat(subname, country, SUBNAMESIZ);
959 if (state != NULL) {
960 (void) strlcat(subname, ", ST=", SUBNAMESIZ);
961 (void) strlcat(subname, state, SUBNAMESIZ);
962 }
963
964 if (locality != NULL) {
965 (void) strlcat(subname, ", L=", SUBNAMESIZ);
966 (void) strlcat(subname, locality, SUBNAMESIZ);
967 }
968
969 if (org != NULL) {
970 (void) strlcat(subname, ", O=", SUBNAMESIZ);
971 (void) strlcat(subname, org, SUBNAMESIZ);
972 }
973
974 if (unit != NULL) {
975 (void) strlcat(subname, ", OU=", SUBNAMESIZ);
976 (void) strlcat(subname, unit, SUBNAMESIZ);
977 }
978
979 if (name != NULL) {
980 (void) strlcat(subname, ", CN=", SUBNAMESIZ);
981 (void) strlcat(subname, name, SUBNAMESIZ);
982 }
983
984 if (email != NULL) {
985 (void) strlcat(subname, ", E=", SUBNAMESIZ);
986 (void) strlcat(subname, email, SUBNAMESIZ);
987 }
988
989 out:
990 free(country);
991 free(state);
992 free(locality);
993 free(org);
994 free(unit);
995 free(name);
996 free(email);
997
998 if (subname == NULL)
999 return (-1);
1000 else {
1001 *result = subname;
1002 return (0);
1003 }
1004 }
1005
1006 /*
1007 * Parse a string of KeyUsage values and convert
1008 * them to the correct KU Bits.
1009 * The field may be marked "critical" by prepending
1010 * "critical:" to the list.
1011 * EX: critical:digitialSignature,keyEncipherment
1012 */
1013 KMF_RETURN
1014 verify_keyusage(char *kustr, uint16_t *kubits, int *critical)
1015 {
1016 KMF_RETURN ret = KMF_OK;
1017 uint16_t kuval;
1018 char *k;
1019
1020 *kubits = 0;
1021 if (kustr == NULL || strlen(kustr) == 0)
1022 return (KMF_ERR_BAD_PARAMETER);
1023
1024 /* Check to see if this is critical */
1025 if (strncasecmp(kustr, "critical:", strlen("critical:")) == 0) {
1026 *critical = TRUE;
1027 kustr += strlen("critical:");
1028 } else {
1029 *critical = FALSE;
1030 }
1031
1032 k = strtok(kustr, ",");
1033 while (k != NULL) {
1034 kuval = kmf_string_to_ku(k);
1035 if (kuval == 0) {
1036 *kubits = 0;
1037 return (KMF_ERR_BAD_PARAMETER);
1038 }
1039 *kubits |= kuval;
1040 k = strtok(NULL, ",");
1041 }
1042
1043 return (ret);
1044 }
1045
1046 /*
1047 * Verify the alternate subject label is real or invalid.
1048 *
1049 * The field may be marked "critical" by prepending
1050 * "critical:" to the list.
1051 * EX: "critical:IP=1.2.3.4"
1052 */
1053 KMF_RETURN
1054 verify_altname(char *arg, KMF_GENERALNAMECHOICES *type, int *critical)
1055 {
1056 char *p;
1057 KMF_RETURN rv = KMF_OK;
1058
1059 /* Check to see if this is critical */
1060 if (strncasecmp(arg, "critical:", strlen("critical:")) == 0) {
1061 *critical = TRUE;
1062 arg += strlen("critical:");
1063 } else {
1064 *critical = FALSE;
1065 }
1066
1067 /* Make sure there is an "=" sign */
1068 p = strchr(arg, '=');
1069 if (p == NULL)
1070 return (KMF_ERR_BAD_PARAMETER);
1071
1072 p[0] = '\0';
1073
1074 if (strcmp(arg, "IP") == 0)
1075 *type = GENNAME_IPADDRESS;
1076 else if (strcmp(arg, "DNS") == 0)
1077 *type = GENNAME_DNSNAME;
1078 else if (strcmp(arg, "EMAIL") == 0)
1079 *type = GENNAME_RFC822NAME;
1080 else if (strcmp(arg, "URI") == 0)
1081 *type = GENNAME_URI;
1082 else if (strcmp(arg, "DN") == 0)
1083 *type = GENNAME_DIRECTORYNAME;
1084 else if (strcmp(arg, "RID") == 0)
1085 *type = GENNAME_REGISTEREDID;
1086 else if (strcmp(arg, "KRB") == 0)
1087 *type = GENNAME_KRB5PRINC;
1088 else if (strcmp(arg, "UPN") == 0)
1089 *type = GENNAME_SCLOGON_UPN;
1090 else
1091 rv = KMF_ERR_BAD_PARAMETER;
1092
1093 p[0] = '=';
1094
1095 return (rv);
1096 }
1097
1098 int
1099 get_token_password(KMF_KEYSTORE_TYPE kstype,
1100 char *token_spec, KMF_CREDENTIAL *cred)
1101 {
1102 char prompt[1024];
1103 char temptoken[32];
1104 char *p = NULL;
1105 char *t = NULL;
1106 int len;
1107
1108 (void) memset(temptoken, 0, sizeof (temptoken));
1109 if (kstype == KMF_KEYSTORE_PK11TOKEN) {
1110 p = strchr(token_spec, ':');
1111 if (p != NULL)
1112 *p = 0;
1113 }
1114 len = strlen(token_spec);
1115 if (len > sizeof (temptoken))
1116 len = sizeof (temptoken);
1117
1118 (void) strncpy(temptoken, token_spec, len);
1119
1120 /*
1121 * Strip trailing whitespace
1122 */
1123 t = temptoken + (len - 1);
1124 while (isspace(*t) && t >= temptoken) {
1125 *t = 0x00;
1126 t--;
1127 }
1128
1129 /*
1130 * Login to the token first.
1131 */
1132 (void) snprintf(prompt, sizeof (prompt),
1133 gettext(DEFAULT_TOKEN_PROMPT), temptoken);
1134
1135 if (get_pin(prompt, NULL, (uchar_t **)&cred->cred,
1136 (ulong_t *)&cred->credlen) != CKR_OK) {
1137 cred->cred = NULL;
1138 cred->credlen = 0;
1139 }
1140
1141 if (kstype == KMF_KEYSTORE_PK11TOKEN && p != NULL)
1142 *p = ':';
1143 return (KMF_OK);
1144 }
1145
1146 KMF_RETURN
1147 verify_file(char *filename)
1148 {
1149 KMF_RETURN ret = KMF_OK;
1150 int fd;
1151
1152 /*
1153 * Attempt to open with the EXCL flag so that if
1154 * it already exists, the open will fail. It will
1155 * also fail if the file cannot be created due to
1156 * permissions on the parent directory, or if the
1157 * parent directory itself does not exist.
1158 */
1159 fd = open(filename, O_CREAT | O_EXCL, 0600);
1160 if (fd == -1) {
1161 if (errno == EEXIST)
1162 return (KMF_ERR_OPEN_FILE);
1163 else
1164 return (KMF_ERR_WRITE_FILE);
1165 }
1166
1167 /* If we were able to create it, delete it. */
1168 (void) close(fd);
1169 (void) unlink(filename);
1170
1171 return (ret);
1172 }
1173
1174 void
1175 display_error(void *handle, KMF_RETURN errcode, char *prefix)
1176 {
1177 KMF_RETURN rv1, rv2;
1178 char *plugin_errmsg = NULL;
1179 char *kmf_errmsg = NULL;
1180
1181 rv1 = kmf_get_plugin_error_str(handle, &plugin_errmsg);
1182 rv2 = kmf_get_kmf_error_str(errcode, &kmf_errmsg);
1183
1184 cryptoerror(LOG_STDERR, "%s:", prefix);
1185 if (rv1 == KMF_OK && plugin_errmsg) {
1186 cryptoerror(LOG_STDERR, gettext("keystore error: %s"),
1187 plugin_errmsg);
1188 kmf_free_str(plugin_errmsg);
1189 }
1190
1191 if (rv2 == KMF_OK && kmf_errmsg) {
1192 cryptoerror(LOG_STDERR, gettext("libkmf error: %s"),
1193 kmf_errmsg);
1194 kmf_free_str(kmf_errmsg);
1195 }
1196
1197 if (rv1 != KMF_OK && rv2 != KMF_OK)
1198 cryptoerror(LOG_STDERR, gettext("<unknown error>\n"));
1199
1200 }
1201
1202 static KMF_RETURN
1203 addToEKUList(EKU_LIST *ekus, int critical, KMF_OID *newoid)
1204 {
1205 if (newoid != NULL && ekus != NULL) {
1206 ekus->eku_count++;
1207
1208 ekus->critlist = reallocarray(ekus->critlist,
1209 ekus->eku_count, sizeof (int));
1210 if (ekus->critlist != NULL)
1211 ekus->critlist[ekus->eku_count-1] = critical;
1212 else
1213 return (KMF_ERR_MEMORY);
1214
1215 ekus->ekulist = reallocarray(ekus->ekulist, ekus->eku_count,
1216 sizeof (KMF_OID));
1217 if (ekus->ekulist != NULL)
1218 ekus->ekulist[ekus->eku_count-1] = *newoid;
1219 else
1220 return (KMF_ERR_MEMORY);
1221 }
1222 return (KMF_OK);
1223 }
1224
1225 void
1226 free_eku_list(EKU_LIST *ekus)
1227 {
1228 if (ekus != NULL && ekus->eku_count > 0) {
1229 int i;
1230 for (i = 0; i < ekus->eku_count; i++) {
1231 kmf_free_data(&ekus->ekulist[i]);
1232 }
1233 free(ekus->ekulist);
1234 free(ekus->critlist);
1235 free(ekus);
1236 }
1237 }
1238
1239 static KMF_RETURN
1240 parse_ekus(char *ekustr, EKU_LIST *ekus)
1241 {
1242 KMF_RETURN rv = KMF_OK;
1243 KMF_OID *newoid;
1244 int critical;
1245
1246 if (strncasecmp(ekustr, "critical:",
1247 strlen("critical:")) == 0) {
1248 critical = TRUE;
1249 ekustr += strlen("critical:");
1250 } else {
1251 critical = FALSE;
1252 }
1253 newoid = kmf_ekuname_to_oid(ekustr);
1254 if (newoid != NULL) {
1255 rv = addToEKUList(ekus, critical, newoid);
1256 free(newoid);
1257 } else {
1258 rv = PK_ERR_USAGE;
1259 }
1260
1261 return (rv);
1262 }
1263
1264 KMF_RETURN
1265 verify_ekunames(char *ekuliststr, EKU_LIST **ekulist)
1266 {
1267 KMF_RETURN rv = KMF_OK;
1268 char *p;
1269 EKU_LIST *ekus = NULL;
1270
1271 if (ekuliststr == NULL || strlen(ekuliststr) == 0)
1272 return (0);
1273
1274 ekus = calloc(sizeof (EKU_LIST), 1);
1275 if (ekus == NULL)
1276 return (KMF_ERR_MEMORY);
1277
1278 /*
1279 * The list should be comma separated list of EKU Names.
1280 */
1281 p = strtok(ekuliststr, ",");
1282
1283 /* If no tokens found, then maybe it's just a single EKU value */
1284 if (p == NULL) {
1285 rv = parse_ekus(ekuliststr, ekus);
1286 }
1287
1288 while (p != NULL) {
1289 rv = parse_ekus(p, ekus);
1290
1291 if (rv != KMF_OK)
1292 break;
1293 p = strtok(NULL, ",");
1294 }
1295
1296 if (rv != KMF_OK)
1297 free_eku_list(ekus);
1298 else
1299 *ekulist = ekus;
1300
1301 return (rv);
1302 }
1303
1304 KMF_RETURN
1305 token_auth_needed(KMF_HANDLE_T handle, char *tokenlabel, int *auth)
1306 {
1307 CK_TOKEN_INFO info;
1308 CK_SLOT_ID slot;
1309 CK_RV ckrv;
1310 KMF_RETURN rv;
1311
1312 *auth = 0;
1313 rv = kmf_pk11_token_lookup(handle, tokenlabel, &slot);
1314 if (rv != KMF_OK)
1315 return (rv);
1316
1317 ckrv = C_GetTokenInfo(slot, &info);
1318 if (ckrv != KMF_OK)
1319 return (KMF_ERR_INTERNAL);
1320
1321 *auth = (info.flags & CKF_LOGIN_REQUIRED);
1322
1323 return (KMF_OK);
1324 }
1325
1326 void
1327 show_ecc_curves()
1328 {
1329 int i;
1330
1331 (void) printf(gettext("Supported ECC curve names:\n"));
1332 for (i = 0; i < number_of_curves; i++) {
1333 (void) printf("%s", oid_table[i].name);
1334 if (i > 0 && ((i+1) % 5) == 0)
1335 (void) printf("\n");
1336 else if (i+1 < number_of_curves)
1337 (void) printf(", ");
1338 }
1339 (void) printf("\n");
1340 }
1341
1342 KMF_OID *
1343 ecc_name_to_oid(char *name)
1344 {
1345 int i;
1346 for (i = 0; i < number_of_oids; i++) {
1347 if (strcasecmp(name, oid_table[i].name) == 0)
1348 return ((KMF_OID *)oid_table[i].oid);
1349 }
1350 return (NULL);
1351 }
unleashed repo fork