Clarify documentation of password quality check modules
[heimdal.git] / lib / hx509 / lock.c
blob07e9d36125587f0e7501159563a9f05ddb8155f7
1 /*
2 * Copyright (c) 2005 - 2006 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
34 #include "hx_locl.h"
36 /**
37 * @page page_lock Locking and unlocking certificates and encrypted data.
39 * See the library functions here: @ref hx509_lock
42 struct hx509_lock_data {
43 struct _hx509_password password;
44 hx509_certs certs;
45 hx509_prompter_fct prompt;
46 void *prompt_data;
49 static struct hx509_lock_data empty_lock_data = {
50 { 0, NULL }
53 hx509_lock _hx509_empty_lock = &empty_lock_data;
59 int
60 hx509_lock_init(hx509_context context, hx509_lock *lock)
62 hx509_lock l;
63 int ret;
65 *lock = NULL;
67 l = calloc(1, sizeof(*l));
68 if (l == NULL)
69 return ENOMEM;
71 ret = hx509_certs_init(context,
72 "MEMORY:locks-internal",
74 NULL,
75 &l->certs);
76 if (ret) {
77 free(l);
78 return ret;
81 *lock = l;
83 return 0;
86 int
87 hx509_lock_add_password(hx509_lock lock, const char *password)
89 void *d;
90 char *s;
92 s = strdup(password);
93 if (s == NULL)
94 return ENOMEM;
96 d = realloc(lock->password.val,
97 (lock->password.len + 1) * sizeof(lock->password.val[0]));
98 if (d == NULL) {
99 free(s);
100 return ENOMEM;
102 lock->password.val = d;
103 lock->password.val[lock->password.len] = s;
104 lock->password.len++;
106 return 0;
109 const struct _hx509_password *
110 _hx509_lock_get_passwords(hx509_lock lock)
112 return &lock->password;
115 hx509_certs
116 _hx509_lock_unlock_certs(hx509_lock lock)
118 return lock->certs;
121 void
122 hx509_lock_reset_passwords(hx509_lock lock)
124 int i;
125 for (i = 0; i < lock->password.len; i++)
126 free(lock->password.val[i]);
127 free(lock->password.val);
128 lock->password.val = NULL;
129 lock->password.len = 0;
133 hx509_lock_add_cert(hx509_context context, hx509_lock lock, hx509_cert cert)
135 return hx509_certs_add(context, lock->certs, cert);
139 hx509_lock_add_certs(hx509_context context, hx509_lock lock, hx509_certs certs)
141 return hx509_certs_merge(context, lock->certs, certs);
144 void
145 hx509_lock_reset_certs(hx509_context context, hx509_lock lock)
147 hx509_certs certs = lock->certs;
148 int ret;
150 ret = hx509_certs_init(context,
151 "MEMORY:locks-internal",
153 NULL,
154 &lock->certs);
155 if (ret == 0)
156 hx509_certs_free(&certs);
157 else
158 lock->certs = certs;
162 _hx509_lock_find_cert(hx509_lock lock, const hx509_query *q, hx509_cert *c)
164 *c = NULL;
165 return 0;
169 hx509_lock_set_prompter(hx509_lock lock, hx509_prompter_fct prompt, void *data)
171 lock->prompt = prompt;
172 lock->prompt_data = data;
173 return 0;
176 void
177 hx509_lock_reset_promper(hx509_lock lock)
179 lock->prompt = NULL;
180 lock->prompt_data = NULL;
183 static int
184 default_prompter(void *data, const hx509_prompt *prompter)
186 if (hx509_prompt_hidden(prompter->type)) {
187 if(UI_UTIL_read_pw_string(prompter->reply.data,
188 prompter->reply.length,
189 prompter->prompt,
191 return 1;
192 } else {
193 char *s = prompter->reply.data;
195 fputs (prompter->prompt, stdout);
196 fflush (stdout);
197 if(fgets(prompter->reply.data,
198 prompter->reply.length,
199 stdin) == NULL)
200 return 1;
201 s[strcspn(s, "\n")] = '\0';
203 return 0;
207 hx509_lock_prompt(hx509_lock lock, hx509_prompt *prompt)
209 if (lock->prompt == NULL)
210 return HX509_CRYPTO_NO_PROMPTER;
211 return (*lock->prompt)(lock->prompt_data, prompt);
214 void
215 hx509_lock_free(hx509_lock lock)
217 if (lock) {
218 hx509_certs_free(&lock->certs);
219 hx509_lock_reset_passwords(lock);
220 memset(lock, 0, sizeof(*lock));
221 free(lock);
226 hx509_prompt_hidden(hx509_prompt_type type)
228 /* default to hidden if unknown */
230 switch (type) {
231 case HX509_PROMPT_TYPE_QUESTION:
232 case HX509_PROMPT_TYPE_INFO:
233 return 0;
234 default:
235 return 1;
240 hx509_lock_command_string(hx509_lock lock, const char *string)
242 if (strncasecmp(string, "PASS:", 5) == 0) {
243 hx509_lock_add_password(lock, string + 5);
244 } else if (strcasecmp(string, "PROMPT") == 0) {
245 hx509_lock_set_prompter(lock, default_prompter, NULL);
246 } else
247 return HX509_UNKNOWN_LOCK_COMMAND;
248 return 0;