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.
33 #include <sys/cdefs.h>
36 * key_call.c, Interface to keyserver
38 * setsecretkey(key) - set your secret key
39 * encryptsessionkey(agent, deskey) - encrypt a session key to talk to agent
40 * decryptsessionkey(agent, deskey) - decrypt ditto
41 * gendeskey(deskey) - generate a secure des key
45 #include <reentrant.h>
52 #include <rpc/auth_unix.h>
53 #include <rpc/key_prot.h>
55 #include <netconfig.h>
56 #include <sys/utsname.h>
60 #include <sys/fcntl.h>
63 #define KEY_TIMEOUT 5 /* per-try timeout in seconds */
64 #define KEY_NRETRY 12 /* number of retries */
67 #define debug(msg) (void) fprintf(stderr, "%s\n", msg);
73 * Hack to allow the keyserver to use AUTH_DES (for authenticated
74 * NIS+ calls, for example). The only functions that get called
75 * are key_encryptsession_pk, key_decryptsession_pk, and key_gendes.
77 * The approach is to have the keyserver fill in pointers to local
78 * implementations of these functions, and to call those in key_call().
81 cryptkeyres *(*__key_encryptsession_pk_LOCAL)() = 0;
82 cryptkeyres *(*__key_decryptsession_pk_LOCAL)() = 0;
83 des_block *(*__key_gendes_LOCAL)() = 0;
85 static int key_call( u_long, xdrproc_t, void *, xdrproc_t, void *);
88 key_setsecret(secretkey)
89 const char *secretkey;
93 if (!key_call((u_long) KEY_SET, (xdrproc_t)xdr_keybuf,
95 (xdrproc_t)xdr_keystatus, &status)) {
98 if (status != KEY_SUCCESS) {
99 debug("set status is nonzero");
106 /* key_secretkey_is_set() returns 1 if the keyserver has a secret key
107 * stored for the caller's effective uid; it returns 0 otherwise
109 * N.B.: The KEY_NET_GET key call is undocumented. Applications shouldn't
110 * be using it, because it allows them to get the user's secret key.
114 key_secretkey_is_set(void)
116 struct key_netstres kres;
118 memset((void*)&kres, 0, sizeof (kres));
119 if (key_call((u_long) KEY_NET_GET, (xdrproc_t)xdr_void, NULL,
120 (xdrproc_t)xdr_key_netstres, &kres) &&
121 (kres.status == KEY_SUCCESS) &&
122 (kres.key_netstres_u.knet.st_priv_key[0] != 0)) {
123 /* avoid leaving secret key in memory */
124 memset(kres.key_netstres_u.knet.st_priv_key, 0, HEXKEYBYTES);
131 key_encryptsession_pk(remotename, remotekey, deskey)
139 arg.remotename = remotename;
140 arg.remotekey = *remotekey;
141 arg.deskey = *deskey;
142 if (!key_call((u_long)KEY_ENCRYPT_PK, (xdrproc_t)xdr_cryptkeyarg2, &arg,
143 (xdrproc_t)xdr_cryptkeyres, &res)) {
146 if (res.status != KEY_SUCCESS) {
147 debug("encrypt status is nonzero");
150 *deskey = res.cryptkeyres_u.deskey;
155 key_decryptsession_pk(remotename, remotekey, deskey)
163 arg.remotename = remotename;
164 arg.remotekey = *remotekey;
165 arg.deskey = *deskey;
166 if (!key_call((u_long)KEY_DECRYPT_PK, (xdrproc_t)xdr_cryptkeyarg2, &arg,
167 (xdrproc_t)xdr_cryptkeyres, &res)) {
170 if (res.status != KEY_SUCCESS) {
171 debug("decrypt status is nonzero");
174 *deskey = res.cryptkeyres_u.deskey;
179 key_encryptsession(remotename, deskey)
180 const char *remotename;
186 arg.remotename = (char *) remotename;
187 arg.deskey = *deskey;
188 if (!key_call((u_long)KEY_ENCRYPT, (xdrproc_t)xdr_cryptkeyarg, &arg,
189 (xdrproc_t)xdr_cryptkeyres, &res)) {
192 if (res.status != KEY_SUCCESS) {
193 debug("encrypt status is nonzero");
196 *deskey = res.cryptkeyres_u.deskey;
201 key_decryptsession(remotename, deskey)
202 const char *remotename;
208 arg.remotename = (char *) remotename;
209 arg.deskey = *deskey;
210 if (!key_call((u_long)KEY_DECRYPT, (xdrproc_t)xdr_cryptkeyarg, &arg,
211 (xdrproc_t)xdr_cryptkeyres, &res)) {
214 if (res.status != KEY_SUCCESS) {
215 debug("decrypt status is nonzero");
218 *deskey = res.cryptkeyres_u.deskey;
226 if (!key_call((u_long)KEY_GEN, (xdrproc_t)xdr_void, NULL,
227 (xdrproc_t)xdr_des_block, key)) {
235 struct key_netstarg *arg;
240 if (!key_call((u_long) KEY_NET_PUT, (xdrproc_t)xdr_key_netstarg, arg,
241 (xdrproc_t)xdr_keystatus, &status)){
245 if (status != KEY_SUCCESS) {
246 debug("key_setnet status is nonzero");
254 key_get_conv(pkey, deskey)
260 if (!key_call((u_long) KEY_GET_CONV, (xdrproc_t)xdr_keybuf, pkey,
261 (xdrproc_t)xdr_cryptkeyres, &res)) {
264 if (res.status != KEY_SUCCESS) {
265 debug("get_conv status is nonzero");
268 *deskey = res.cryptkeyres_u.deskey;
272 struct key_call_private {
273 CLIENT *client; /* Client handle */
274 pid_t pid; /* process-id at moment of creation */
275 uid_t uid; /* user-id at last authorization */
277 static struct key_call_private *key_call_private_main = NULL;
280 key_call_destroy(void *vp)
282 struct key_call_private *kcp = (struct key_call_private *)vp;
286 clnt_destroy(kcp->client);
292 * Keep the handle cached. This call may be made quite often.
295 getkeyserv_handle(vers)
299 struct netconfig *nconf;
300 struct netconfig *tpconf;
301 struct key_call_private *kcp = key_call_private_main;
302 struct timeval wait_time;
305 extern thread_key_t key_call_key;
306 extern mutex_t tsd_lock;
308 #define TOTAL_TIMEOUT 30 /* total timeout talking to keyserver */
309 #define TOTAL_TRIES 5 /* Number of tries */
311 if (key_call_key == -1) {
312 mutex_lock(&tsd_lock);
313 if (key_call_key == -1)
314 thr_keycreate(&key_call_key, key_call_destroy);
315 mutex_unlock(&tsd_lock);
317 kcp = (struct key_call_private *)thr_getspecific(key_call_key);
318 if (kcp == (struct key_call_private *)NULL) {
319 kcp = (struct key_call_private *)malloc(sizeof (*kcp));
320 if (kcp == (struct key_call_private *)NULL) {
321 return ((CLIENT *) NULL);
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__)
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(proc, xdr_arg, arg, xdr_rslt, rslt)
424 struct timeval wait_time;
426 if (proc == KEY_ENCRYPT_PK && __key_encryptsession_pk_LOCAL) {
428 res = (*__key_encryptsession_pk_LOCAL)(geteuid(), arg);
429 *(cryptkeyres*)rslt = *res;
431 } else if (proc == KEY_DECRYPT_PK && __key_decryptsession_pk_LOCAL) {
433 res = (*__key_decryptsession_pk_LOCAL)(geteuid(), arg);
434 *(cryptkeyres*)rslt = *res;
436 } else if (proc == KEY_GEN && __key_gendes_LOCAL) {
438 res = (*__key_gendes_LOCAL)(geteuid(), 0);
439 *(des_block*)rslt = *res;
443 if ((proc == KEY_ENCRYPT_PK) || (proc == KEY_DECRYPT_PK) ||
444 (proc == KEY_NET_GET) || (proc == KEY_NET_PUT) ||
445 (proc == KEY_GET_CONV))
446 clnt = getkeyserv_handle(2); /* talk to version 2 */
448 clnt = getkeyserv_handle(1); /* talk to version 1 */
454 wait_time.tv_sec = TOTAL_TIMEOUT;
455 wait_time.tv_usec = 0;
457 if (clnt_call(clnt, proc, xdr_arg, arg, xdr_rslt, rslt,
458 wait_time) == RPC_SUCCESS) {