1 /*
2 * Common Public License Version 0.5
3 *
4 * THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF
5 * THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE,
6 * REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
7 * RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
8 *
9 * 1. DEFINITIONS
10 *
11 * "Contribution" means:
12 * a) in the case of the initial Contributor, the
13 * initial code and documentation distributed under
14 * this Agreement, and
15 *
16 * b) in the case of each subsequent Contributor:
17 * i) changes to the Program, and
18 * ii) additions to the Program;
19 *
20 * where such changes and/or additions to the Program
21 * originate from and are distributed by that
22 * particular Contributor. A Contribution 'originates'
23 * from a Contributor if it was added to the Program
24 * by such Contributor itself or anyone acting on such
25 * Contributor's behalf. Contributions do not include
26 * additions to the Program which: (i) are separate
27 * modules of software distributed in conjunction with
28 * the Program under their own license agreement, and
29 * (ii) are not derivative works of the Program.
30 *
31 *
32 * "Contributor" means any person or entity that distributes
33 * the Program.
34 *
35 * "Licensed Patents " mean patent claims licensable by a
36 * Contributor which are necessarily infringed by the use or
37 * sale of its Contribution alone or when combined with the
38 * Program.
39 *
40 * "Program" means the Contributions distributed in
41 * accordance with this Agreement.
42 *
43 * "Recipient" means anyone who receives the Program under
44 * this Agreement, including all Contributors.
45 *
46 * 2. GRANT OF RIGHTS
47 *
48 * a) Subject to the terms of this Agreement, each
49 * Contributor hereby grants Recipient a
50 * no - exclusive, worldwide, royalt - free copyright
51 * license to reproduce, prepare derivative works of,
52 * publicly display, publicly perform, distribute and
53 * sublicense the Contribution of such Contributor, if
54 * any, and such derivative works, in source code and
55 * object code form.
56 *
57 * b) Subject to the terms of this Agreement, each
58 * Contributor hereby grants Recipient a
59 * no - exclusive, worldwide, royalt - free patent
60 * license under Licensed Patents to make, use, sell,
61 * offer to sell, import and otherwise transfer the
62 * Contribution of such Contributor, if any, in source
63 * code and object code form. This patent license
64 * shall apply to the combination of the Contribution
65 * and the Program if, at the time the Contribution is
66 * added by the Contributor, such addition of the
67 * Contribution causes such combination to be covered
68 * by the Licensed Patents. The patent license shall
69 * not apply to any other combinations which include
70 * the Contribution. No hardware per se is licensed
71 * hereunder.
72 *
73 * c) Recipient understands that although each
74 * Contributor grants the licenses to its
75 * Contributions set forth herein, no assurances are
76 * provided by any Contributor that the Program does
77 * not infringe the patent or other intellectual
78 * property rights of any other entity. Each
79 * Contributor disclaims any liability to Recipient
80 * for claims brought by any other entity based on
81 * infringement of intellectual property rights or
82 * otherwise. As a condition to exercising the rights
83 * and licenses granted hereunder, each Recipient
84 * hereby assumes sole responsibility to secure any
85 * other intellectual property rights needed, if any.
86 *
87 * For example, if a third party patent license is
88 * required to allow Recipient to distribute the
89 * Program, it is Recipient's responsibility to
90 * acquire that license before distributing the
91 * Program.
92 *
93 * d) Each Contributor represents that to its
94 * knowledge it has sufficient copyright rights in its
95 * Contribution, if any, to grant the copyright
96 * license set forth in this Agreement.
97 *
98 * 3. REQUIREMENTS
99 *
100 * A Contributor may choose to distribute the Program in
101 * object code form under its own license agreement, provided
102 * that:
103 * a) it complies with the terms and conditions of
104 * this Agreement; and
105 *
106 * b) its license agreement:
107 * i) effectively disclaims on behalf of all
108 * Contributors all warranties and conditions, express
109 * and implied, including warranties or conditions of
110 * title and no - infringement, and implied warranties
111 * or conditions of merchantability and fitness for a
112 * particular purpose;
113 *
114 * ii) effectively excludes on behalf of all
115 * Contributors all liability for damages, including
116 * direct, indirect, special, incidental and
117 * consequential damages, such as lost profits;
118 *
119 * iii) states that any provisions which differ from
120 * this Agreement are offered by that Contributor
121 * alone and not by any other party; and
122 *
123 * iv) states that source code for the Program is
124 * available from such Contributor, and informs
125 * licensees how to obtain it in a reasonable manner
126 * on or through a medium customarily used for
127 * software exchange.
128 *
129 * When the Program is made available in source code form:
130 * a) it must be made available under this Agreement;
131 * and
132 * b) a copy of this Agreement must be included with
133 * each copy of the Program.
134 *
135 * Contributors may not remove or alter any copyright notices
136 * contained within the Program.
137 *
138 * Each Contributor must identify itself as the originator of
139 * its Contribution, if any, in a manner that reasonably
140 * allows subsequent Recipients to identify the originator of
141 * the Contribution.
142 *
143 *
144 * 4. COMMERCIAL DISTRIBUTION
145 *
146 * Commercial distributors of software may accept certain
147 * responsibilities with respect to end users, business
148 * partners and the like. While this license is intended to
149 * facilitate the commercial use of the Program, the
150 * Contributor who includes the Program in a commercial
151 * product offering should do so in a manner which does not
152 * create potential liability for other Contributors.
153 * Therefore, if a Contributor includes the Program in a
154 * commercial product offering, such Contributor ("Commercial
155 * Contributor") hereby agrees to defend and indemnify every
156 * other Contributor ("Indemnified Contributor") against any
157 * losses, damages and costs (collectively "Losses") arising
158 * from claims, lawsuits and other legal actions brought by a
159 * third party against the Indemnified Contributor to the
160 * extent caused by the acts or omissions of such Commercial
161 * Contributor in connection with its distribution of the
162 * Program in a commercial product offering. The obligations
163 * in this section do not apply to any claims or Losses
164 * relating to any actual or alleged intellectual property
165 * infringement. In order to qualify, an Indemnified
166 * Contributor must: a) promptly notify the Commercial
167 * Contributor in writing of such claim, and b) allow the
168 * Commercial Contributor to control, and cooperate with the
169 * Commercial Contributor in, the defense and any related
170 * settlement negotiations. The Indemnified Contributor may
171 * participate in any such claim at its own expense.
172 *
173 *
174 * For example, a Contributor might include the Program in a
175 * commercial product offering, Product X. That Contributor
176 * is then a Commercial Contributor. If that Commercial
177 * Contributor then makes performance claims, or offers
178 * warranties related to Product X, those performance claims
179 * and warranties are such Commercial Contributor's
180 * responsibility alone. Under this section, the Commercial
181 * Contributor would have to defend claims against the other
182 * Contributors related to those performance claims and
183 * warranties, and if a court requires any other Contributor
184 * to pay any damages as a result, the Commercial Contributor
185 * must pay those damages.
186 *
187 *
188 * 5. NO WARRANTY
189 *
190 * EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE
191 * PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT
192 * WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
193 * IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR
194 * CONDITIONS OF TITLE, NO - INFRINGEMENT, MERCHANTABILITY OR
195 * FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely
196 * responsible for determining the appropriateness of using
197 * and distributing the Program and assumes all risks
198 * associated with its exercise of rights under this
199 * Agreement, including but not limited to the risks and
200 * costs of program errors, compliance with applicable laws,
201 * damage to or loss of data, programs or equipment, and
202 * unavailability or interruption of operations.
203 *
204 * 6. DISCLAIMER OF LIABILITY
205 * EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER
206 * RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY
207 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
208 * OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
209 * LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF
210 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
211 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
212 * OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE
213 * OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
214 * POSSIBILITY OF SUCH DAMAGES.
215 *
216 * 7. GENERAL
217 *
218 * If any provision of this Agreement is invalid or
219 * unenforceable under applicable law, it shall not affect
220 * the validity or enforceability of the remainder of the
221 * terms of this Agreement, and without further action by the
222 * parties hereto, such provision shall be reformed to the
223 * minimum extent necessary to make such provision valid and
224 * enforceable.
225 *
226 *
227 * If Recipient institutes patent litigation against a
228 * Contributor with respect to a patent applicable to
229 * software (including a cros - claim or counterclaim in a
230 * lawsuit), then any patent licenses granted by that
231 * Contributor to such Recipient under this Agreement shall
232 * terminate as of the date such litigation is filed. In
233 * addition, If Recipient institutes patent litigation
234 * against any entity (including a cros - claim or
235 * counterclaim in a lawsuit) alleging that the Program
236 * itself (excluding combinations of the Program with other
237 * software or hardware) infringes such Recipient's
238 * patent(s), then such Recipient's rights granted under
239 * Section 2(b) shall terminate as of the date such
240 * litigation is filed.
241 *
242 * All Recipient's rights under this Agreement shall
243 * terminate if it fails to comply with any of the material
244 * terms or conditions of this Agreement and does not cure
245 * such failure in a reasonable period of time after becoming
246 * aware of such noncompliance. If all Recipient's rights
247 * under this Agreement terminate, Recipient agrees to cease
248 * use and distribution of the Program as soon as reasonably
249 * practicable. However, Recipient's obligations under this
250 * Agreement and any licenses granted by Recipient relating
251 * to the Program shall continue and survive.
252 *
253 * Everyone is permitted to copy and distribute copies of
254 * this Agreement, but in order to avoid inconsistency the
255 * Agreement is copyrighted and may only be modified in the
256 * following manner. The Agreement Steward reserves the right
257 * to publish new versions (including revisions) of this
258 * Agreement from time to time. No one other than the
259 * Agreement Steward has the right to modify this Agreement.
260 *
261 * IBM is the initial Agreement Steward. IBM may assign the
262 * responsibility to serve as the Agreement Steward to a
263 * suitable separate entity. Each new version of the
264 * Agreement will be given a distinguishing version number.
265 * The Program (including Contributions) may always be
266 * distributed subject to the version of the Agreement under
267 * which it was received. In addition, after a new version of
268 * the Agreement is published, Contributor may elect to
269 * distribute the Program (including its Contributions) under
270 * the new version. Except as expressly stated in Sections
271 * 2(a) and 2(b) above, Recipient receives no rights or
272 * licenses to the intellectual property of any Contributor
273 * under this Agreement, whether expressly, by implication,
274 * estoppel or otherwise. All rights in the Program not
275 * expressly granted under this Agreement are reserved.
276 *
277 *
278 * This Agreement is governed by the laws of the State of New
279 * York and the intellectual property laws of the United
280 * States of America. No party to this Agreement will bring a
281 * legal action under this Agreement more than one year after
282 * the cause of action arose. Each party waives its rights to
283 * a jury trial in any resulting litigation.
284 *
285 *
286 *
287 * (C) COPYRIGHT International Business Machines Corp. 2001, 2002
288 */
289 /*
290 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
291 * Use is subject to license terms.
292 */
293
294 #include "tpmtok_int.h"
295
296 #include <stdarg.h>
297 #include <syslog.h>
298 #include <sys/types.h>
299 #include <sys/stat.h>
300
301
302 void stlogit(char *, ...);
303
304
305 extern int debugfile;
306 pthread_mutex_t lmtx = PTHREAD_MUTEX_INITIALIZER;
307
308 static int enabled = 0;
309 static int logging = 0;
310 static int env_log_check = 0;
311
312 void
stloginit()313 stloginit() {
314 char *logval;
315 if (! env_log_check) {
316 logval = getenv("PKCS_ERROR_LOG");
317 env_log_check = 1;
318 if (logval != NULL)
319 logging = 1;
320 else
321 logging = 0;
322 }
323 if (! enabled && logging) {
324 enabled = 1;
325 openlog((const char *)token_specific.token_debug_tag,
326 LOG_PID | LOG_NDELAY, LOG_LOCAL6);
327 (void) setlogmask(LOG_UPTO(LOG_DEBUG));
328
329 #ifdef DEBUG
330 debugfile = 1;
331 #else
332 debugfile = 0;
333 #endif
334 stlogit("Log initialized");
335 }
336 }
337
338 void
stlogterm()339 stlogterm()
340 {
341 enabled = 0;
342 }
343
344 /*PRINTFLIKE2*/
345 void
stlogit2(int type,char * fmt,...)346 stlogit2(int type, char *fmt, ...)
347 {
348 va_list pvar;
349 char buffer[4096*4];
350
351 if (! enabled) stloginit();
352
353 if (enabled && type) {
354 va_start(pvar, fmt);
355 (void) vsnprintf(buffer, sizeof (buffer), fmt, pvar);
356 va_end(pvar);
357 (void) pthread_mutex_lock(&lmtx);
358 syslog(LOG_DEBUG, buffer);
359 (void) pthread_mutex_unlock(&lmtx);
360 }
361 }
362
363 /*PRINTFLIKE1*/
364 void
stlogit(char * fmt,...)365 stlogit(char *fmt, ...)
366 {
367 va_list pvar;
368 char buffer[4096*4];
369
370 if (! enabled) stloginit();
371
372 if (enabled && debugfile) {
373 va_start(pvar, fmt);
374 (void) vsnprintf(buffer, sizeof (buffer), fmt, pvar);
375 va_end(pvar);
376 (void) pthread_mutex_lock(&lmtx);
377 syslog(LOG_DEBUG, buffer);
378 (void) pthread_mutex_unlock(&lmtx);
379 }
380 }
381
382 /* moved in from msg.h */
383
384 struct messages err_msg[] = {
385 { "Malloc Failed" },
386 { "Not Enough Memory in Context" },
387 { "Slot Invalid" },
388 { "General Error" },
389 { "%s Function Failed" },
390 // #5
391 { "%s Bad Arguments" },
392 { "No Event" },
393 { "Attribute Read Only" },
394 { "Attribute Type Invalid" },
395 { "Attribute Value Invalid" },
396 // #10
397 { "Data Invalid" },
398 { "Data Length out of Range" },
399 { "Device Error" },
400 { "Device Removed" },
401 { "Encrypted Data Invalid" },
402 // 15
403 { "Encrypted Data Length out of Range" },
404 { "Function Cancelled" },
405 { "Function Not Parallel" },
406 { "Key Handle Invalid" },
407 { "Key Size out of Range" },
408 // 20
409 { "Key Type Inconsistent" },
410 { "Key Not Needed" },
411 { "Key Changed" },
412 { "Key Needed" },
413 { "Key Indigestible" },
414 // 25
415 { "Key Function Not Permitted" },
416 { "Key Not Wrappable" },
417 { "Key Unextractable" },
418 { "Mechanism Invalid" },
419 { "Mechanism Param Invalid" },
420 // 30
421 { "Object Handle Invalid" },
422 { "Operation Active" },
423 { "Operation Not Initialized" },
424 { "Pin Incorrect" },
425 { "Pin Invalid" },
426 // 35
427 { "Pin Length out of Range" },
428 { "Pin Expired" },
429 { "Pin Locked" },
430 { "Session Closed" },
431 { "Session Count" },
432 // 40
433 { "Session Handle Invalid" },
434 { "Parallel Session Not Supported" },
435 { "Session Read Only" },
436 { "Session Exists" },
437 { "Session Read only Exists" },
438 // 45
439 { "Session Read Write Exists" },
440 { "Signature Length out of Range" },
441 { "Signature Invalid" },
442 { "Template Incomplete" },
443 { "Template Inconsistent" },
444 // 50
445 { "Token Not Present" },
446 { "Token Not Recognized" },
447 { "Token Write Protected" },
448 { "Unwrapping Key Handle Invalid" },
449 { "Unwrapping Key Size Range Invalid" },
450 // 55
451 { "Unwrapping Key Type Inconsistent" },
452 { "User Already Logged In" },
453 { "User Not Logged In" },
454 { "User PIN Not Initialized" },
455 { "User Type Invalid" },
456 // 60
457 { "Another User Already Logged In" },
458 { "Too Many User Types" },
459 { "Wrapped Key Invalid" },
460 { "Wrapped Key Length Out of Range" },
461 { "Wrapping Key Size out of Range" },
462 // 65
463 { "Wrapping Key Type Inconsistent" },
464 { "Random Seed Not Supported" },
465 { "Random Number Invalid" },
466 { "Buffer Too Small" },
467 { "Saved State Invalid" },
468 // 70
469 { "Information Sensitive" },
470 { "State Unsaveable" },
471 { "API not initialized" },
472 { "API already Initialized" },
473 { "Mutex Bad" },
474 // 75
475 { "Mutex Lock Invalid" },
476 { "Encode Integer Failed" },
477 { "Encode Octet String Failed" },
478 { "Encode Sequence Failed" },
479 { "Decode Integer Failed" },
480 // 80
481 { "Decode Octet String Failed" },
482 { "Decode Sequence Failed" },
483 { "Encode Private Key Failed" },
484 { "Decode Private Key Failed" },
485 { "Build Attribute Failed" },
486 // 85
487 { "Function Not Permitted" },
488 { "Key Not Exportable" },
489 { "Encode Private Key failed" },
490 { "Decode Private Key failed" },
491 { "Object Mgr Create Skeleton failed" },
492 // 90
493 { "Object Mgr Create Final failed" },
494 { "Key Generation failed" },
495 { "DES Wrap Get Data Failed" },
496 { "DES3 Wrap Get Data Failed" },
497 { "RSA Wrap Get Data Failed" },
498 // 95
499 { "DSA Wrap Get Data Failed" },
500 { "Generic Secret Wrap Get Data Failed" },
501 { "DES Wrap Format Failed" },
502 { "Encryption Mgr Init Failed" },
503 { "Encryption Mgr Encrypt Failed" },
504 // 100
505 { "Decryption Mgr Decrypt Failed" },
506 { "Flatten Object Failed" },
507 { "Key Mgr Get Priv Key Type Failed" },
508 { "Decrypt Private Key Info Failed" },
509 { "Save Token Failed" },
510 // 105
511 { "Triple DES CBC Encrypt Failed" },
512 { "Triple DES CBC Decrypt Failed" },
513 { "Restore Private Token Failed" },
514 { "Restore Object Failed" },
515 { "Data Length Out of Range" },
516 // 110
517 { "Object Manager Find in Map Failed" },
518 { "Token Specific RNG Failed" },
519 { "Encrypted Data Length Out of Range" },
520 { "DES CBC Encrypt Failed" },
521 { "DES CBC Decrypt Failed" },
522 // 115
523 { "DES ECB Encrypt Failed" },
524 { "DES ECB Decrypt Failed" },
525 { "Token Specific DES ECB Failed" },
526 { "Token Specific DES CBC Failed" },
527 { "Token Specific 3DES CBC Failed" },
528 // 120
529 { "Token Specific 3DES ECB Failed" },
530 { "DSA Verify Failed" },
531 { "DSA Sign Failed" },
532 { "Digest Init Failed" },
533 { "Digest Failed" },
534 // 125
535 { "Digest Update Failed" },
536 { "Digest Final Failed" },
537 { "Sign Init Failed" },
538 { "Sign Update Failed" },
539 { "Sign Final Failed" },
540 // 130
541 { "Random Number Generate Failed" },
542 { "RSA Format Block Failed" },
543 { "RSA Encrypt Failed" },
544 { "RSA Decrypt Failed" },
545 { "Token Specific RSA Encrypt Failed" },
546 // 135
547 { "Token Specific RSA Decrypt Failed" },
548 { "SSL SHA Failed" },
549 { "SSL3 MD5 Failed" },
550 { "SSL3 Process MAC Keys Failed" },
551 { "SSL3 Process Write Keys Failed" },
552 // 140
553 { "Validate Attribute Failed" },
554 { "SSL3 Process Write Keys Failed" },
555 { "%s Function Not Supported" },
556 { "Token Already Initialized" },
557 { "Cannot Attach to Shared Memory" },
558 // 145
559 { "Token Specific Init Failed" },
560 { "Mutex Lock Failed" },
561 { "Mutex Unlock Failed" },
562 { "Hash Computation Failed" },
563 { "Save Master Key Failed" },
564 // 150
565 { "Process Lock Failed" },
566 { "Process Unlock Failed" },
567 { "Session Mgr New Failed" },
568 { "Close all Sessions Failed" },
569 { "Session Mgr Get Op State Failed" },
570 // 155
571 { "Load Master Key Failed" },
572 { "Object Create Failed" },
573 { "Object Mgr Add to Map Failed" },
574 { "Object Copy Failed" },
575 { "Object Get Attribute Values Failed" },
576 // 160
577 { "Object Restore Data Failed" },
578 { "Object Set Attribute Values Failed" },
579 { "Object Mgr Search for Object Failed" },
580 { "Copy Template Failed" },
581 { "Add Attribute Failed" },
582 // 165
583 { "Check Required Attributes Failed" },
584 { "Unflatten Template Failed" },
585 { "Verify Init Failed" },
586 { "Verify Failed" },
587 { "Verify Update Failed" },
588 // 170
589 { "Verify Final Failed" },
590 { "Sign Failed" },
591 { "Set Default Attributes Failed" },
592 { "Unwrap Key Failed" },
593 { "Session Mgr New Failed" },
594 // 175
595 { "Merge Attributes Failed" },
596 { "Encryption Mgr Encrypt Update Failed" },
597 { "Encryption Mgr Encrypt Final Failed" },
598 { "Update Attribute Failed" },
599 { "Decryption Mgr Init Failed" },
600 // 180
601 { "Decryption Mgr Update Failed" },
602 { "Decryption Mgr Final Failed" },
603 { "Object Mgr Destroy Failed" },
604 { "Attribute Undefined" },
605 { "Object Mgr Get Size Failed" },
606 // 185
607 { "Object Manager Find Init Failed" },
608 { "Sign Recover Failed" },
609 { "Verify Recover Failed" },
610 { "Wrap Key Failed" },
611 { "Unwrap Key Failed" },
612 // 190
613 { "Derive Key Failed" },
614 { "AES Wrap Get Data Failed" },
615 { "AES Wrap Format Failed" },
616 { "Domain Parameter Invalid" },
617 { "File \"%s\" could not be opened, errno =%d" }
618 };
619