2 * Copyright 2004-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2004, EdelKey Project. All Rights Reserved.
5 * Licensed under the OpenSSL license (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
10 * Originally written by Christophe Renou and Peter Sylvester,
11 * for the EdelKey project.
14 #include <openssl/opensslconf.h>
16 NON_EMPTY_TRANSLATION_UNIT
22 # include <openssl/conf.h>
23 # include <openssl/bio.h>
24 # include <openssl/err.h>
25 # include <openssl/txt_db.h>
26 # include <openssl/buffer.h>
27 # include <openssl/srp.h>
31 # define BASE_SECTION "srp"
32 # define CONFIG_FILE "openssl.cnf"
35 # define ENV_DATABASE "srpvfile"
36 # define ENV_DEFAULT_SRP "default_srp"
38 static int get_index(CA_DB
*db
, char *id
, char type
)
44 if (type
== DB_SRP_INDEX
) {
45 for (i
= 0; i
< sk_OPENSSL_PSTRING_num(db
->db
->data
); i
++) {
46 pp
= sk_OPENSSL_PSTRING_value(db
->db
->data
, i
);
47 if (pp
[DB_srptype
][0] == DB_SRP_INDEX
48 && strcmp(id
, pp
[DB_srpid
]) == 0)
52 for (i
= 0; i
< sk_OPENSSL_PSTRING_num(db
->db
->data
); i
++) {
53 pp
= sk_OPENSSL_PSTRING_value(db
->db
->data
, i
);
55 if (pp
[DB_srptype
][0] != DB_SRP_INDEX
56 && strcmp(id
, pp
[DB_srpid
]) == 0)
64 static void print_entry(CA_DB
*db
, int indx
, int verbose
, char *s
)
66 if (indx
>= 0 && verbose
) {
68 char **pp
= sk_OPENSSL_PSTRING_value(db
->db
->data
, indx
);
69 BIO_printf(bio_err
, "%s \"%s\"\n", s
, pp
[DB_srpid
]);
70 for (j
= 0; j
< DB_NUMBER
; j
++) {
71 BIO_printf(bio_err
, " %d = \"%s\"\n", j
, pp
[j
]);
76 static void print_index(CA_DB
*db
, int indexindex
, int verbose
)
78 print_entry(db
, indexindex
, verbose
, "g N entry");
81 static void print_user(CA_DB
*db
, int userindex
, int verbose
)
84 char **pp
= sk_OPENSSL_PSTRING_value(db
->db
->data
, userindex
);
86 if (pp
[DB_srptype
][0] != 'I') {
87 print_entry(db
, userindex
, verbose
, "User entry");
88 print_entry(db
, get_index(db
, pp
[DB_srpgN
], 'I'), verbose
,
95 static int update_index(CA_DB
*db
, char **row
)
100 irow
= app_malloc(sizeof(*irow
) * (DB_NUMBER
+ 1), "row pointers");
101 for (i
= 0; i
< DB_NUMBER
; i
++)
103 irow
[DB_NUMBER
] = NULL
;
105 if (!TXT_DB_insert(db
->db
, irow
)) {
106 BIO_printf(bio_err
, "failed to update srpvfile\n");
107 BIO_printf(bio_err
, "TXT_DB error number %ld\n", db
->db
->error
);
114 static char *lookup_conf(const CONF
*conf
, const char *section
, const char *tag
)
116 char *entry
= NCONF_get_string(conf
, section
, tag
);
118 BIO_printf(bio_err
, "variable lookup failed for %s::%s\n", section
, tag
);
122 static char *srp_verify_user(const char *user
, const char *srp_verifier
,
123 char *srp_usersalt
, const char *g
, const char *N
,
124 const char *passin
, int verbose
)
128 char *verifier
= NULL
;
132 cb_tmp
.prompt_info
= user
;
133 cb_tmp
.password
= passin
;
135 len
= password_callback(password
, sizeof(password
)-1, 0, &cb_tmp
);
140 "Validating\n user=\"%s\"\n srp_verifier=\"%s\"\n srp_usersalt=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
141 user
, srp_verifier
, srp_usersalt
, g
, N
);
143 BIO_printf(bio_err
, "Pass %s\n", password
);
145 OPENSSL_assert(srp_usersalt
!= NULL
);
146 if ((gNid
= SRP_create_verifier(user
, password
, &srp_usersalt
,
147 &verifier
, N
, g
)) == NULL
) {
148 BIO_printf(bio_err
, "Internal error validating SRP verifier\n");
150 if (strcmp(verifier
, srp_verifier
))
152 OPENSSL_free(verifier
);
154 OPENSSL_cleanse(password
, len
);
159 static char *srp_create_user(char *user
, char **srp_verifier
,
160 char **srp_usersalt
, char *g
, char *N
,
161 char *passout
, int verbose
)
168 cb_tmp
.prompt_info
= user
;
169 cb_tmp
.password
= passout
;
171 len
= password_callback(password
, sizeof(password
)-1, 1, &cb_tmp
);
175 BIO_printf(bio_err
, "Creating\n user=\"%s\"\n g=\"%s\"\n N=\"%s\"\n",
177 if ((gNid
= SRP_create_verifier(user
, password
, &salt
,
178 srp_verifier
, N
, g
)) == NULL
) {
179 BIO_printf(bio_err
, "Internal error creating SRP verifier\n");
181 *srp_usersalt
= salt
;
183 OPENSSL_cleanse(password
, len
);
185 BIO_printf(bio_err
, "gNid=%s salt =\"%s\"\n verifier =\"%s\"\n",
186 gNid
, salt
, *srp_verifier
);
192 typedef enum OPTION_choice
{
193 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
,
194 OPT_VERBOSE
, OPT_CONFIG
, OPT_NAME
, OPT_SRPVFILE
, OPT_ADD
,
195 OPT_DELETE
, OPT_MODIFY
, OPT_LIST
, OPT_GN
, OPT_USERINFO
,
196 OPT_PASSIN
, OPT_PASSOUT
, OPT_ENGINE
, OPT_R_ENUM
199 const OPTIONS srp_options
[] = {
200 {"help", OPT_HELP
, '-', "Display this summary"},
201 {"verbose", OPT_VERBOSE
, '-', "Talk a lot while doing things"},
202 {"config", OPT_CONFIG
, '<', "A config file"},
203 {"name", OPT_NAME
, 's', "The particular srp definition to use"},
204 {"srpvfile", OPT_SRPVFILE
, '<', "The srp verifier file name"},
205 {"add", OPT_ADD
, '-', "Add a user and srp verifier"},
206 {"modify", OPT_MODIFY
, '-',
207 "Modify the srp verifier of an existing user"},
208 {"delete", OPT_DELETE
, '-', "Delete user from verifier file"},
209 {"list", OPT_LIST
, '-', "List users"},
210 {"gn", OPT_GN
, 's', "Set g and N values to be used for new verifier"},
211 {"userinfo", OPT_USERINFO
, 's', "Additional info to be set for user"},
212 {"passin", OPT_PASSIN
, 's', "Input file pass phrase source"},
213 {"passout", OPT_PASSOUT
, 's', "Output file pass phrase source"},
215 # ifndef OPENSSL_NO_ENGINE
216 {"engine", OPT_ENGINE
, 's', "Use engine, possibly a hardware device"},
221 int srp_main(int argc
, char **argv
)
226 int gNindex
= -1, maxgN
= -1, ret
= 1, errors
= 0, verbose
= 0, i
;
227 int doupdatedb
= 0, mode
= OPT_ERR
;
228 char *user
= NULL
, *passinarg
= NULL
, *passoutarg
= NULL
;
229 char *passin
= NULL
, *passout
= NULL
, *gN
= NULL
, *userinfo
= NULL
;
230 char *section
= NULL
;
231 char **gNrow
= NULL
, *configfile
= NULL
;
232 char *srpvfile
= NULL
, **pp
, *prog
;
235 prog
= opt_init(argc
, argv
, srp_options
);
236 while ((o
= opt_next()) != OPT_EOF
) {
241 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
244 opt_help(srp_options
);
251 configfile
= opt_arg();
257 srpvfile
= opt_arg();
263 if (mode
!= OPT_ERR
) {
265 "%s: Only one of -add/-delete/-modify/-list\n",
275 userinfo
= opt_arg();
278 passinarg
= opt_arg();
281 passoutarg
= opt_arg();
284 e
= setup_engine(opt_arg(), 0);
292 argc
= opt_num_rest();
295 if (srpvfile
!= NULL
&& configfile
!= NULL
) {
297 "-srpvfile and -configfile cannot be specified together.\n");
300 if (mode
== OPT_ERR
) {
302 "Exactly one of the options -add, -delete, -modify -list must be specified.\n");
305 if (mode
== OPT_DELETE
|| mode
== OPT_MODIFY
|| mode
== OPT_ADD
) {
307 BIO_printf(bio_err
, "Need at least one user.\n");
312 if ((passinarg
!= NULL
|| passoutarg
!= NULL
) && argc
!= 1) {
314 "-passin, -passout arguments only valid with one user.\n");
318 if (!app_passwd(passinarg
, passoutarg
, &passin
, &passout
)) {
319 BIO_printf(bio_err
, "Error getting passwords\n");
323 if (srpvfile
== NULL
) {
324 if (configfile
== NULL
)
325 configfile
= default_config_file
;
328 BIO_printf(bio_err
, "Using configuration from %s\n",
330 conf
= app_load_config(configfile
);
333 if (configfile
!= default_config_file
&& !app_load_modules(conf
))
336 /* Lets get the config section we are using */
337 if (section
== NULL
) {
340 "trying to read " ENV_DEFAULT_SRP
341 " in " BASE_SECTION
"\n");
343 section
= lookup_conf(conf
, BASE_SECTION
, ENV_DEFAULT_SRP
);
348 app_RAND_load_conf(conf
, BASE_SECTION
);
352 "trying to read " ENV_DATABASE
" in section \"%s\"\n",
355 srpvfile
= lookup_conf(conf
, section
, ENV_DATABASE
);
356 if (srpvfile
== NULL
)
361 BIO_printf(bio_err
, "Trying to read SRP verifier file \"%s\"\n",
364 db
= load_index(srpvfile
, NULL
);
368 /* Lets check some fields */
369 for (i
= 0; i
< sk_OPENSSL_PSTRING_num(db
->db
->data
); i
++) {
370 pp
= sk_OPENSSL_PSTRING_value(db
->db
->data
, i
);
372 if (pp
[DB_srptype
][0] == DB_SRP_INDEX
) {
374 if ((gNindex
< 0) && (gN
!= NULL
) && strcmp(gN
, pp
[DB_srpid
]) == 0)
377 print_index(db
, i
, verbose
> 1);
382 BIO_printf(bio_err
, "Database initialised\n");
385 gNrow
= sk_OPENSSL_PSTRING_value(db
->db
->data
, gNindex
);
386 print_entry(db
, gNindex
, verbose
> 1, "Default g and N");
387 } else if (maxgN
> 0 && !SRP_get_default_gN(gN
)) {
388 BIO_printf(bio_err
, "No g and N value for index \"%s\"\n", gN
);
392 BIO_printf(bio_err
, "Database has no g N information.\n");
397 BIO_printf(bio_err
, "Starting user processing\n");
399 while (mode
== OPT_LIST
|| user
!= NULL
) {
402 if (user
!= NULL
&& verbose
> 1)
403 BIO_printf(bio_err
, "Processing user \"%s\"\n", user
);
404 if ((userindex
= get_index(db
, user
, 'U')) >= 0)
405 print_user(db
, userindex
, (verbose
> 0) || mode
== OPT_LIST
);
407 if (mode
== OPT_LIST
) {
409 BIO_printf(bio_err
, "List all users\n");
411 for (i
= 0; i
< sk_OPENSSL_PSTRING_num(db
->db
->data
); i
++)
412 print_user(db
, i
, 1);
413 } else if (userindex
< 0) {
415 "user \"%s\" does not exist, ignored. t\n", user
);
418 } else if (mode
== OPT_ADD
) {
419 if (userindex
>= 0) {
420 /* reactivation of a new user */
422 sk_OPENSSL_PSTRING_value(db
->db
->data
, userindex
);
423 BIO_printf(bio_err
, "user \"%s\" reactivated.\n", user
);
424 row
[DB_srptype
][0] = 'V';
428 char *row
[DB_NUMBER
];
430 row
[DB_srpverifier
] = NULL
;
431 row
[DB_srpsalt
] = NULL
;
432 row
[DB_srpinfo
] = NULL
;
435 srp_create_user(user
, &(row
[DB_srpverifier
]),
437 gNrow
? gNrow
[DB_srpsalt
] : gN
,
438 gNrow
? gNrow
[DB_srpverifier
] : NULL
,
439 passout
, verbose
))) {
441 "Cannot create srp verifier for user \"%s\", operation abandoned .\n",
446 row
[DB_srpid
] = OPENSSL_strdup(user
);
447 row
[DB_srptype
] = OPENSSL_strdup("v");
448 row
[DB_srpgN
] = OPENSSL_strdup(gNid
);
450 if ((row
[DB_srpid
] == NULL
)
451 || (row
[DB_srpgN
] == NULL
)
452 || (row
[DB_srptype
] == NULL
)
453 || (row
[DB_srpverifier
] == NULL
)
454 || (row
[DB_srpsalt
] == NULL
)
456 && ((row
[DB_srpinfo
] = OPENSSL_strdup(userinfo
)) == NULL
))
457 || !update_index(db
, row
)) {
458 OPENSSL_free(row
[DB_srpid
]);
459 OPENSSL_free(row
[DB_srpgN
]);
460 OPENSSL_free(row
[DB_srpinfo
]);
461 OPENSSL_free(row
[DB_srptype
]);
462 OPENSSL_free(row
[DB_srpverifier
]);
463 OPENSSL_free(row
[DB_srpsalt
]);
468 } else if (mode
== OPT_MODIFY
) {
471 "user \"%s\" does not exist, operation ignored.\n",
477 sk_OPENSSL_PSTRING_value(db
->db
->data
, userindex
);
478 char type
= row
[DB_srptype
][0];
481 "user \"%s\" already updated, operation ignored.\n",
487 if (row
[DB_srptype
][0] == 'V') {
492 "Verifying password for user \"%s\"\n",
495 get_index(db
, row
[DB_srpgN
], DB_SRP_INDEX
)) >= 0)
497 sk_OPENSSL_PSTRING_value(db
->db
->data
,
501 (user
, row
[DB_srpverifier
], row
[DB_srpsalt
],
502 irow
? irow
[DB_srpsalt
] : row
[DB_srpgN
],
503 irow
? irow
[DB_srpverifier
] : NULL
, passin
,
506 "Invalid password for user \"%s\", operation abandoned.\n",
513 BIO_printf(bio_err
, "Password for user \"%s\" ok.\n",
518 srp_create_user(user
, &(row
[DB_srpverifier
]),
520 gNrow
? gNrow
[DB_srpsalt
] : NULL
,
521 gNrow
? gNrow
[DB_srpverifier
] : NULL
,
522 passout
, verbose
))) {
524 "Cannot create srp verifier for user \"%s\", operation abandoned.\n",
530 row
[DB_srptype
][0] = 'v';
531 row
[DB_srpgN
] = OPENSSL_strdup(gNid
);
533 if (row
[DB_srpid
] == NULL
534 || row
[DB_srpgN
] == NULL
535 || row
[DB_srptype
] == NULL
536 || row
[DB_srpverifier
] == NULL
537 || row
[DB_srpsalt
] == NULL
539 && ((row
[DB_srpinfo
] = OPENSSL_strdup(userinfo
))
546 } else if (mode
== OPT_DELETE
) {
549 "user \"%s\" does not exist, operation ignored. t\n",
553 char **xpp
= sk_OPENSSL_PSTRING_value(db
->db
->data
, userindex
);
555 BIO_printf(bio_err
, "user \"%s\" revoked. t\n", user
);
556 xpp
[DB_srptype
][0] = 'R';
562 /* no more processing in any mode if no users left */
568 BIO_printf(bio_err
, "User procession done.\n");
571 /* Lets check some fields */
572 for (i
= 0; i
< sk_OPENSSL_PSTRING_num(db
->db
->data
); i
++) {
573 pp
= sk_OPENSSL_PSTRING_value(db
->db
->data
, i
);
575 if (pp
[DB_srptype
][0] == 'v') {
576 pp
[DB_srptype
][0] = 'V';
577 print_user(db
, i
, verbose
);
582 BIO_printf(bio_err
, "Trying to update srpvfile.\n");
583 if (!save_index(srpvfile
, "new", db
))
587 BIO_printf(bio_err
, "Temporary srpvfile created.\n");
588 if (!rotate_index(srpvfile
, "new", "old"))
592 BIO_printf(bio_err
, "srpvfile updated.\n");
599 BIO_printf(bio_err
, "User errors %d.\n", errors
);
602 BIO_printf(bio_err
, "SRP terminating with code %d.\n", ret
);
604 OPENSSL_free(passin
);
605 OPENSSL_free(passout
);
607 ERR_print_errors(bio_err
);