2 * Copyright (c) 2009, Sun Microsystems, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * - Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * - Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 * - Neither the name of Sun Microsystems, Inc. nor the names of its
13 * contributors may be used to endorse or promote products derived
14 * from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
29 * Copyright (c) 1986-1991 by Sun Microsystems Inc.
32 #ident "@(#)key_call.c 1.25 94/04/24 SMI"
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 * key_call.c, Interface to keyserver
39 * setsecretkey(key) - set your secret key
40 * encryptsessionkey(agent, deskey) - encrypt a session key to talk to agent
41 * decryptsessionkey(agent, deskey) - decrypt ditto
42 * gendeskey(deskey) - generate a secure des key
45 #include "namespace.h"
46 #include "reentrant.h"
53 #include <rpc/auth_unix.h>
54 #include <rpc/key_prot.h>
56 #include <netconfig.h>
57 #include <sys/utsname.h>
61 #include <sys/fcntl.h>
62 #include "un-namespace.h"
66 #define KEY_TIMEOUT 5 /* per-try timeout in seconds */
67 #define KEY_NRETRY 12 /* number of retries */
70 #define debug(msg) (void) fprintf(stderr, "%s\n", msg);
76 * Hack to allow the keyserver to use AUTH_DES (for authenticated
77 * NIS+ calls, for example). The only functions that get called
78 * are key_encryptsession_pk, key_decryptsession_pk, and key_gendes.
80 * The approach is to have the keyserver fill in pointers to local
81 * implementations of these functions, and to call those in key_call().
84 cryptkeyres *(*__key_encryptsession_pk_LOCAL)(uid_t, void *arg) = 0;
85 cryptkeyres *(*__key_decryptsession_pk_LOCAL)(uid_t, void *arg) = 0;
86 des_block *(*__key_gendes_LOCAL)(uid_t, void *) = 0;
88 static int key_call( u_long, xdrproc_t, void *, xdrproc_t, void *);
91 key_setsecret(const char *secretkey)
95 if (!key_call((u_long) KEY_SET, (xdrproc_t)xdr_keybuf,
97 (xdrproc_t)xdr_keystatus, &status)) {
100 if (status != KEY_SUCCESS) {
101 debug("set status is nonzero");
108 /* key_secretkey_is_set() returns 1 if the keyserver has a secret key
109 * stored for the caller's effective uid; it returns 0 otherwise
111 * N.B.: The KEY_NET_GET key call is undocumented. Applications shouldn't
112 * be using it, because it allows them to get the user's secret key.
116 key_secretkey_is_set(void)
118 struct key_netstres kres;
120 memset((void*)&kres, 0, sizeof (kres));
121 if (key_call((u_long) KEY_NET_GET, (xdrproc_t)xdr_void, NULL,
122 (xdrproc_t)xdr_key_netstres, &kres) &&
123 (kres.status == KEY_SUCCESS) &&
124 (kres.key_netstres_u.knet.st_priv_key[0] != 0)) {
125 /* avoid leaving secret key in memory */
126 memset(kres.key_netstres_u.knet.st_priv_key, 0, HEXKEYBYTES);
133 key_encryptsession_pk(char *remotename, netobj *remotekey, des_block *deskey)
138 arg.remotename = remotename;
139 arg.remotekey = *remotekey;
140 arg.deskey = *deskey;
141 if (!key_call((u_long)KEY_ENCRYPT_PK, (xdrproc_t)xdr_cryptkeyarg2, &arg,
142 (xdrproc_t)xdr_cryptkeyres, &res)) {
145 if (res.status != KEY_SUCCESS) {
146 debug("encrypt status is nonzero");
149 *deskey = res.cryptkeyres_u.deskey;
154 key_decryptsession_pk(char *remotename, netobj *remotekey, des_block *deskey)
159 arg.remotename = remotename;
160 arg.remotekey = *remotekey;
161 arg.deskey = *deskey;
162 if (!key_call((u_long)KEY_DECRYPT_PK, (xdrproc_t)xdr_cryptkeyarg2, &arg,
163 (xdrproc_t)xdr_cryptkeyres, &res)) {
166 if (res.status != KEY_SUCCESS) {
167 debug("decrypt status is nonzero");
170 *deskey = res.cryptkeyres_u.deskey;
175 key_encryptsession(const char *remotename, des_block *deskey)
180 arg.remotename = (char *) remotename;
181 arg.deskey = *deskey;
182 if (!key_call((u_long)KEY_ENCRYPT, (xdrproc_t)xdr_cryptkeyarg, &arg,
183 (xdrproc_t)xdr_cryptkeyres, &res)) {
186 if (res.status != KEY_SUCCESS) {
187 debug("encrypt status is nonzero");
190 *deskey = res.cryptkeyres_u.deskey;
195 key_decryptsession(const char *remotename, des_block *deskey)
200 arg.remotename = (char *) remotename;
201 arg.deskey = *deskey;
202 if (!key_call((u_long)KEY_DECRYPT, (xdrproc_t)xdr_cryptkeyarg, &arg,
203 (xdrproc_t)xdr_cryptkeyres, &res)) {
206 if (res.status != KEY_SUCCESS) {
207 debug("decrypt status is nonzero");
210 *deskey = res.cryptkeyres_u.deskey;
215 key_gendes(des_block *key)
217 if (!key_call((u_long)KEY_GEN, (xdrproc_t)xdr_void, NULL,
218 (xdrproc_t)xdr_des_block, key)) {
225 key_setnet(struct key_netstarg *arg)
230 if (!key_call((u_long) KEY_NET_PUT, (xdrproc_t)xdr_key_netstarg, arg,
231 (xdrproc_t)xdr_keystatus, &status)){
235 if (status != KEY_SUCCESS) {
236 debug("key_setnet status is nonzero");
244 key_get_conv(char *pkey, des_block *deskey)
248 if (!key_call((u_long) KEY_GET_CONV, (xdrproc_t)xdr_keybuf, pkey,
249 (xdrproc_t)xdr_cryptkeyres, &res)) {
252 if (res.status != KEY_SUCCESS) {
253 debug("get_conv status is nonzero");
256 *deskey = res.cryptkeyres_u.deskey;
260 struct key_call_private {
261 CLIENT *client; /* Client handle */
262 pid_t pid; /* process-id at moment of creation */
263 uid_t uid; /* user-id at last authorization */
265 static struct key_call_private *key_call_private_main = NULL;
266 static thread_key_t key_call_key;
267 static once_t key_call_once = ONCE_INITIALIZER;
268 static int key_call_key_error;
271 key_call_destroy(void *vp)
273 struct key_call_private *kcp = (struct key_call_private *)vp;
277 clnt_destroy(kcp->client);
286 key_call_key_error = thr_keycreate(&key_call_key, key_call_destroy);
290 * Keep the handle cached. This call may be made quite often.
293 getkeyserv_handle(int vers)
296 struct netconfig *nconf;
297 struct netconfig *tpconf;
298 struct key_call_private *kcp;
299 struct timeval wait_time;
304 #define TOTAL_TIMEOUT 30 /* total timeout talking to keyserver */
305 #define TOTAL_TRIES 5 /* Number of tries */
307 if ((main_thread = thr_main())) {
308 kcp = key_call_private_main;
310 if (thr_once(&key_call_once, key_call_init) != 0 ||
311 key_call_key_error != 0)
312 return ((CLIENT *) NULL);
313 kcp = (struct key_call_private *)thr_getspecific(key_call_key);
315 if (kcp == (struct key_call_private *)NULL) {
316 kcp = (struct key_call_private *)malloc(sizeof (*kcp));
317 if (kcp == (struct key_call_private *)NULL) {
318 return ((CLIENT *) NULL);
321 key_call_private_main = kcp;
323 thr_setspecific(key_call_key, (void *) kcp);
327 /* if pid has changed, destroy client and rebuild */
328 if (kcp->client != NULL && kcp->pid != getpid()) {
329 clnt_destroy(kcp->client);
333 if (kcp->client != NULL) {
334 /* if uid has changed, build client handle again */
335 if (kcp->uid != geteuid()) {
336 kcp->uid = geteuid();
337 auth_destroy(kcp->client->cl_auth);
338 kcp->client->cl_auth =
339 authsys_create("", kcp->uid, 0, 0, NULL);
340 if (kcp->client->cl_auth == NULL) {
341 clnt_destroy(kcp->client);
343 return ((CLIENT *) NULL);
346 /* Change the version number to the new one */
347 clnt_control(kcp->client, CLSET_VERS, (void *)&vers);
348 return (kcp->client);
350 if (!(localhandle = setnetconfig())) {
351 return ((CLIENT *) NULL);
354 #if defined(__FreeBSD__)
358 if (_nuname(&u) == -1)
360 if (_uname(&u) == -1)
362 #error Unknown architecture!
366 endnetconfig(localhandle);
367 return ((CLIENT *) NULL);
369 while ((nconf = getnetconfig(localhandle)) != NULL) {
370 if (strcmp(nconf->nc_protofmly, NC_LOOPBACK) == 0) {
372 * We use COTS_ORD here so that the caller can
373 * find out immediately if the server is dead.
375 if (nconf->nc_semantics == NC_TPI_COTS_ORD) {
376 kcp->client = clnt_tp_create(u.nodename,
377 KEY_PROG, vers, nconf);
385 if ((kcp->client == (CLIENT *) NULL) && (tpconf))
386 /* Now, try the CLTS or COTS loopback transport */
387 kcp->client = clnt_tp_create(u.nodename,
388 KEY_PROG, vers, tpconf);
389 endnetconfig(localhandle);
391 if (kcp->client == (CLIENT *) NULL) {
392 return ((CLIENT *) NULL);
394 kcp->uid = geteuid();
396 kcp->client->cl_auth = authsys_create("", kcp->uid, 0, 0, NULL);
397 if (kcp->client->cl_auth == NULL) {
398 clnt_destroy(kcp->client);
400 return ((CLIENT *) NULL);
403 wait_time.tv_sec = TOTAL_TIMEOUT/TOTAL_TRIES;
404 wait_time.tv_usec = 0;
405 (void) clnt_control(kcp->client, CLSET_RETRY_TIMEOUT,
407 if (clnt_control(kcp->client, CLGET_FD, (char *)&fd))
408 _fcntl(fd, F_SETFD, 1); /* make it "close on exec" */
410 return (kcp->client);
413 /* returns 0 on failure, 1 on success */
416 key_call(u_long proc, xdrproc_t xdr_arg, void *arg, xdrproc_t xdr_rslt,
420 struct timeval wait_time;
422 if (proc == KEY_ENCRYPT_PK && __key_encryptsession_pk_LOCAL) {
424 res = (*__key_encryptsession_pk_LOCAL)(geteuid(), arg);
425 *(cryptkeyres*)rslt = *res;
427 } else if (proc == KEY_DECRYPT_PK && __key_decryptsession_pk_LOCAL) {
429 res = (*__key_decryptsession_pk_LOCAL)(geteuid(), arg);
430 *(cryptkeyres*)rslt = *res;
432 } else if (proc == KEY_GEN && __key_gendes_LOCAL) {
434 res = (*__key_gendes_LOCAL)(geteuid(), 0);
435 *(des_block*)rslt = *res;
439 if ((proc == KEY_ENCRYPT_PK) || (proc == KEY_DECRYPT_PK) ||
440 (proc == KEY_NET_GET) || (proc == KEY_NET_PUT) ||
441 (proc == KEY_GET_CONV))
442 clnt = getkeyserv_handle(2); /* talk to version 2 */
444 clnt = getkeyserv_handle(1); /* talk to version 1 */
450 wait_time.tv_sec = TOTAL_TIMEOUT;
451 wait_time.tv_usec = 0;
453 if (clnt_call(clnt, proc, xdr_arg, arg, xdr_rslt, rslt,
454 wait_time) == RPC_SUCCESS) {