xref: /titanic_44/usr/src/lib/libcryptoutil/common/debug.c (revision 7c478bd95313f5f23a4c958a745db2134aa03244)
1*7c478bd9Sstevel@tonic-gate /*
2*7c478bd9Sstevel@tonic-gate  * CDDL HEADER START
3*7c478bd9Sstevel@tonic-gate  *
4*7c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*7c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*7c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*7c478bd9Sstevel@tonic-gate  * with the License.
8*7c478bd9Sstevel@tonic-gate  *
9*7c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*7c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*7c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*7c478bd9Sstevel@tonic-gate  * and limitations under the License.
13*7c478bd9Sstevel@tonic-gate  *
14*7c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*7c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*7c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*7c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*7c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*7c478bd9Sstevel@tonic-gate  *
20*7c478bd9Sstevel@tonic-gate  * CDDL HEADER END
21*7c478bd9Sstevel@tonic-gate  */
22*7c478bd9Sstevel@tonic-gate /*
23*7c478bd9Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*7c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
25*7c478bd9Sstevel@tonic-gate  */
26*7c478bd9Sstevel@tonic-gate 
27*7c478bd9Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
28*7c478bd9Sstevel@tonic-gate 
29*7c478bd9Sstevel@tonic-gate #include <stdio.h>
30*7c478bd9Sstevel@tonic-gate #include <stdlib.h>
31*7c478bd9Sstevel@tonic-gate #include <stdarg.h>
32*7c478bd9Sstevel@tonic-gate #include <syslog.h>
33*7c478bd9Sstevel@tonic-gate #include <string.h>
34*7c478bd9Sstevel@tonic-gate #include <cryptoutil.h>
35*7c478bd9Sstevel@tonic-gate 
36*7c478bd9Sstevel@tonic-gate #define	CRYPTO_DEBUG_ENV	"SUNW_CRYPTO_DEBUG"
37*7c478bd9Sstevel@tonic-gate 
38*7c478bd9Sstevel@tonic-gate static char *_cryptodebug_prefix = NULL;
39*7c478bd9Sstevel@tonic-gate static int _cryptodebug_enabled = -1; /* -1 unknown, 0 disabled, 1 enabled */
40*7c478bd9Sstevel@tonic-gate static boolean_t _cryptodebug_syslog = B_TRUE;
41*7c478bd9Sstevel@tonic-gate 
42*7c478bd9Sstevel@tonic-gate /*PRINTFLIKE1*/
43*7c478bd9Sstevel@tonic-gate void
44*7c478bd9Sstevel@tonic-gate cryptodebug(const char *fmt, ...)
45*7c478bd9Sstevel@tonic-gate {
46*7c478bd9Sstevel@tonic-gate 	va_list args;
47*7c478bd9Sstevel@tonic-gate 	char fmtbuf[BUFSIZ];
48*7c478bd9Sstevel@tonic-gate 	char msgbuf[BUFSIZ];
49*7c478bd9Sstevel@tonic-gate 
50*7c478bd9Sstevel@tonic-gate 	if (fmt == NULL || _cryptodebug_enabled != 1)
51*7c478bd9Sstevel@tonic-gate 		return;
52*7c478bd9Sstevel@tonic-gate 
53*7c478bd9Sstevel@tonic-gate 	va_start(args, fmt);
54*7c478bd9Sstevel@tonic-gate 	if (_cryptodebug_prefix == NULL) {
55*7c478bd9Sstevel@tonic-gate 		(void) vsnprintf(msgbuf, sizeof (msgbuf), fmt, args);
56*7c478bd9Sstevel@tonic-gate 	} else {
57*7c478bd9Sstevel@tonic-gate 		(void) snprintf(fmtbuf, sizeof (fmtbuf), "%s: %s",
58*7c478bd9Sstevel@tonic-gate 		    _cryptodebug_prefix, fmt);
59*7c478bd9Sstevel@tonic-gate 		(void) vsnprintf(msgbuf, sizeof (msgbuf), fmtbuf, args);
60*7c478bd9Sstevel@tonic-gate 	}
61*7c478bd9Sstevel@tonic-gate 
62*7c478bd9Sstevel@tonic-gate 	if (_cryptodebug_syslog) {
63*7c478bd9Sstevel@tonic-gate 		syslog(LOG_DEBUG, msgbuf);
64*7c478bd9Sstevel@tonic-gate 	} else {
65*7c478bd9Sstevel@tonic-gate 		(void) fprintf(stderr, "%s\n", msgbuf);
66*7c478bd9Sstevel@tonic-gate 	}
67*7c478bd9Sstevel@tonic-gate 	va_end(args);
68*7c478bd9Sstevel@tonic-gate }
69*7c478bd9Sstevel@tonic-gate 
70*7c478bd9Sstevel@tonic-gate /*
71*7c478bd9Sstevel@tonic-gate  * cryptoerror
72*7c478bd9Sstevel@tonic-gate  *
73*7c478bd9Sstevel@tonic-gate  * This is intended to be used both by interactive commands like cryptoadm(1m)
74*7c478bd9Sstevel@tonic-gate  * digest(1) etc, and by libraries libpkcs11, libelfsign etc.
75*7c478bd9Sstevel@tonic-gate  *
76*7c478bd9Sstevel@tonic-gate  * A library probably wants most (all?) of its errors going to syslog but
77*7c478bd9Sstevel@tonic-gate  * commands are usually happy for them to go to stderr.
78*7c478bd9Sstevel@tonic-gate  *
79*7c478bd9Sstevel@tonic-gate  * If a syslog priority is passed we log on that priority.  Otherwise we
80*7c478bd9Sstevel@tonic-gate  * use LOG_STDERR to mean use stderr instead. LOG_STDERR is defined in
81*7c478bd9Sstevel@tonic-gate  * cryptoutil.h
82*7c478bd9Sstevel@tonic-gate  */
83*7c478bd9Sstevel@tonic-gate 
84*7c478bd9Sstevel@tonic-gate /*PRINTFLIKE2*/
85*7c478bd9Sstevel@tonic-gate void
86*7c478bd9Sstevel@tonic-gate cryptoerror(int priority, const char *fmt, ...)
87*7c478bd9Sstevel@tonic-gate {
88*7c478bd9Sstevel@tonic-gate 	char fmtbuf[BUFSIZ];
89*7c478bd9Sstevel@tonic-gate 	char msgbuf[BUFSIZ];
90*7c478bd9Sstevel@tonic-gate 	va_list args;
91*7c478bd9Sstevel@tonic-gate 
92*7c478bd9Sstevel@tonic-gate 	if (fmt == NULL)
93*7c478bd9Sstevel@tonic-gate 		return;
94*7c478bd9Sstevel@tonic-gate 
95*7c478bd9Sstevel@tonic-gate 	va_start(args, fmt);
96*7c478bd9Sstevel@tonic-gate 	if (_cryptodebug_prefix == NULL) {
97*7c478bd9Sstevel@tonic-gate 		(void) vsnprintf(msgbuf, sizeof (msgbuf), fmt, args);
98*7c478bd9Sstevel@tonic-gate 	} else {
99*7c478bd9Sstevel@tonic-gate 		(void) snprintf(fmtbuf, sizeof (fmtbuf), "%s: %s",
100*7c478bd9Sstevel@tonic-gate 		    _cryptodebug_prefix, fmt);
101*7c478bd9Sstevel@tonic-gate 		(void) vsnprintf(msgbuf, sizeof (msgbuf), fmtbuf, args);
102*7c478bd9Sstevel@tonic-gate 	}
103*7c478bd9Sstevel@tonic-gate 
104*7c478bd9Sstevel@tonic-gate 	if ((priority == LOG_STDERR) || (priority < 0))  {
105*7c478bd9Sstevel@tonic-gate 		(void) fprintf(stderr, "%s\n", msgbuf);
106*7c478bd9Sstevel@tonic-gate 	} else {
107*7c478bd9Sstevel@tonic-gate 		syslog(priority, msgbuf);
108*7c478bd9Sstevel@tonic-gate 	}
109*7c478bd9Sstevel@tonic-gate 	va_end(args);
110*7c478bd9Sstevel@tonic-gate }
111*7c478bd9Sstevel@tonic-gate 
112*7c478bd9Sstevel@tonic-gate void
113*7c478bd9Sstevel@tonic-gate cryptodebug_init(const char *prefix)
114*7c478bd9Sstevel@tonic-gate {
115*7c478bd9Sstevel@tonic-gate 	char *envval = NULL;
116*7c478bd9Sstevel@tonic-gate 
117*7c478bd9Sstevel@tonic-gate 	if (prefix != NULL) {
118*7c478bd9Sstevel@tonic-gate 		_cryptodebug_prefix = strdup(prefix);
119*7c478bd9Sstevel@tonic-gate 	}
120*7c478bd9Sstevel@tonic-gate 
121*7c478bd9Sstevel@tonic-gate 	if (_cryptodebug_enabled == -1) {
122*7c478bd9Sstevel@tonic-gate 		envval = getenv(CRYPTO_DEBUG_ENV);
123*7c478bd9Sstevel@tonic-gate 		/*
124*7c478bd9Sstevel@tonic-gate 		 * If unset or it isn't one of syslog or stderr
125*7c478bd9Sstevel@tonic-gate 		 * disable debug.
126*7c478bd9Sstevel@tonic-gate 		 */
127*7c478bd9Sstevel@tonic-gate 		if (envval == NULL || (strcmp(envval, "") == 0)) {
128*7c478bd9Sstevel@tonic-gate 			_cryptodebug_enabled = 0;
129*7c478bd9Sstevel@tonic-gate 			return;
130*7c478bd9Sstevel@tonic-gate 		} else if (strcmp(envval, "stderr") == 0) {
131*7c478bd9Sstevel@tonic-gate 			_cryptodebug_syslog = B_FALSE;
132*7c478bd9Sstevel@tonic-gate 			_cryptodebug_enabled = 1;
133*7c478bd9Sstevel@tonic-gate 		} else if (strcmp(envval, "syslog") == 0) {
134*7c478bd9Sstevel@tonic-gate 			_cryptodebug_syslog = B_TRUE;
135*7c478bd9Sstevel@tonic-gate 			_cryptodebug_enabled = 1;
136*7c478bd9Sstevel@tonic-gate 		}
137*7c478bd9Sstevel@tonic-gate 	}
138*7c478bd9Sstevel@tonic-gate 
139*7c478bd9Sstevel@tonic-gate 	openlog(_cryptodebug_prefix, LOG_PID, LOG_USER);
140*7c478bd9Sstevel@tonic-gate }
141*7c478bd9Sstevel@tonic-gate 
142*7c478bd9Sstevel@tonic-gate #pragma fini(_cryptodebug_fini)
143*7c478bd9Sstevel@tonic-gate 
144*7c478bd9Sstevel@tonic-gate static void
145*7c478bd9Sstevel@tonic-gate _cryptodebug_fini(void)
146*7c478bd9Sstevel@tonic-gate {
147*7c478bd9Sstevel@tonic-gate 	if (_cryptodebug_prefix != NULL)
148*7c478bd9Sstevel@tonic-gate 		free(_cryptodebug_prefix);
149*7c478bd9Sstevel@tonic-gate }
150