engines/vendor_defns/hwcryptohook.h

   1 /*-
   2  * ModExp / RSA (with/without KM) plugin API
   3  *
   4  * The application will load a dynamic library which
   5  * exports entrypoint(s) defined in this file.
   6  *
   7  * This set of entrypoints provides only a multithreaded,
   8  * synchronous-within-each-thread, facility.
   9  *
  10  *
  11  * This file is Copyright 1998-2000 nCipher Corporation Limited.
  12  *
  13  * Redistribution and use in source and binary forms, with opr without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  *
  17  * 1. Redistributions of source code must retain the copyright notice,
  18  *    this list of conditions, and the following disclaimer.
  19  *
  20  * 2. Redistributions in binary form must reproduce the above
  21  *    copyright notice, this list of conditions, and the following
  22  *    disclaimer, in the documentation and/or other materials provided
  23  *    with the distribution
  24  *
  25  * IN NO EVENT SHALL NCIPHER CORPORATION LIMITED (`NCIPHER') AND/OR
  26  * ANY OTHER AUTHORS OR DISTRIBUTORS OF THIS FILE BE LIABLE for any
  27  * damages arising directly or indirectly from this file, its use or
  28  * this licence.  Without prejudice to the generality of the
  29  * foregoing: all liability shall be excluded for direct, indirect,
  30  * special, incidental, consequential or other damages or any loss of
  31  * profits, business, revenue goodwill or anticipated savings;
  32  * liability shall be excluded even if nCipher or anyone else has been
  33  * advised of the possibility of damage.  In any event, if the
  34  * exclusion of liability is not effective, the liability of nCipher
  35  * or any author or distributor shall be limited to the lesser of the
  36  * price paid and 1,000 pounds sterling. This licence only fails to
  37  * exclude or limit liability for death or personal injury arising out
  38  * of negligence, and only to the extent that such an exclusion or
  39  * limitation is not effective.
  40  *
  41  * NCIPHER AND THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ALL
  42  * AND ANY WARRANTIES (WHETHER EXPRESS OR IMPLIED), including, but not
  43  * limited to, any implied warranties of merchantability, fitness for
  44  * a particular purpose, satisfactory quality, and/or non-infringement
  45  * of any third party rights.
  46  *
  47  * US Government use: This software and documentation is Commercial
  48  * Computer Software and Computer Software Documentation, as defined in
  49  * sub-paragraphs (a)(1) and (a)(5) of DFAR 252.227-7014, "Rights in
  50  * Noncommercial Computer Software and Noncommercial Computer Software
  51  * Documentation."  Use, duplication or disclosure by the Government is
  52  * subject to the terms and conditions specified here.
  53  *
  54  * By using or distributing this file you will be accepting these
  55  * terms and conditions, including the limitation of liability and
  56  * lack of warranty.  If you do not wish to accept these terms and
  57  * conditions, DO NOT USE THE FILE.
  58  *
  59  *
  60  * The actual dynamically loadable plugin, and the library files for
  61  * static linking, which are also provided in some distributions, are
  62  * not covered by the licence described above.  You should have
  63  * received a separate licence with terms and conditions for these
  64  * library files; if you received the library files without a licence,
  65  * please contact nCipher.
  66  *
  67  *
  68  * $Id: hwcryptohook.h,v 1.1 2002/10/11 17:10:59 levitte Exp $
  69  */
  70
  71 #ifndef HWCRYPTOHOOK_H
  72 #define HWCRYPTOHOOK_H
  73
  74 #include <sys/types.h>
  75 #include <stdio.h>
  76
  77 #ifndef HWCRYPTOHOOK_DECLARE_APPTYPES
  78 #define HWCRYPTOHOOK_DECLARE_APPTYPES 1
  79 #endif
  80
  81 #define HWCRYPTOHOOK_ERROR_FAILED   -1
  82 #define HWCRYPTOHOOK_ERROR_FALLBACK -2
  83 #define HWCRYPTOHOOK_ERROR_MPISIZE  -3
  84
  85 #if HWCRYPTOHOOK_DECLARE_APPTYPES
  86
  87 /*-
  88  * These structs are defined by the application and opaque to the
  89  * crypto plugin.  The application may define these as it sees fit.
  90  * Default declarations are provided here, but the application may
  91  *  #define HWCRYPTOHOOK_DECLARE_APPTYPES 0
  92  * to prevent these declarations, and instead provide its own
  93  * declarations of these types.  (Pointers to them must still be
  94  * ordinary pointers to structs or unions, or the resulting combined
  95  * program will have a type inconsistency.)
  96  */
  97 typedef struct HWCryptoHook_MutexValue HWCryptoHook_Mutex;
  98 typedef struct HWCryptoHook_CondVarValue HWCryptoHook_CondVar;
  99 typedef struct HWCryptoHook_PassphraseContextValue HWCryptoHook_PassphraseContext;
 100 typedef struct HWCryptoHook_CallerContextValue HWCryptoHook_CallerContext;
 101
 102 #endif /* HWCRYPTOHOOK_DECLARE_APPTYPES */
 103
 104 /*-
 105  * These next two structs are opaque to the application.  The crypto
 106  * plugin will return pointers to them; the caller simply manipulates
 107  * the pointers.
 108  */
 109 typedef struct HWCryptoHook_Context *HWCryptoHook_ContextHandle;
 110 typedef struct HWCryptoHook_RSAKey *HWCryptoHook_RSAKeyHandle;
 111
 112 typedef struct {
 113   char *buf;
 114   size_t size;
 115 } HWCryptoHook_ErrMsgBuf;
 116 /*-
 117  * Used for error reporting.  When a HWCryptoHook function fails it
 118  * will return a sentinel value (0 for pointer-valued functions, or a
 119  * negative number, usually HWCRYPTOHOOK_ERROR_FAILED, for
 120  * integer-valued ones).  It will, if an ErrMsgBuf is passed, also put
 121  * an error message there.
 122  *
 123  * size is the size of the buffer, and will not be modified.  If you
 124  * pass 0 for size you must pass 0 for buf, and nothing will be
 125  * recorded (just as if you passed 0 for the struct pointer).
 126  * Messages written to the buffer will always be null-terminated, even
 127  * when truncated to fit within size bytes.
 128  *
 129  * The contents of the buffer are not defined if there is no error.
 130  */
 131
 132 typedef struct HWCryptoHook_MPIStruct {
 133   unsigned char *buf;
 134   size_t size;
 135 } HWCryptoHook_MPI;
 136 /*-
 137  * When one of these is returned, a pointer is passed to the function.
 138  * At call, size is the space available.  Afterwards it is updated to
 139  * be set to the actual length (which may be more than the space available,
 140  * if there was not enough room and the result was truncated).
 141  * buf (the pointer) is not updated.
 142  *
 143  * size is in bytes and may be zero at call or return, but must be a
 144  * multiple of the limb size.  Zero limbs at the MS end are not
 145  * permitted.
 146  */
 147
 148 #define HWCryptoHook_InitFlags_FallbackModExp    0x0002UL
 149 #define HWCryptoHook_InitFlags_FallbackRSAImmed  0x0004UL
 150 /*-
 151  * Enable requesting fallback to software in case of problems with the
 152  * hardware support.  This indicates to the crypto provider that the
 153  * application is prepared to fall back to software operation if the
 154  * ModExp* or RSAImmed* functions return HWCRYPTOHOOK_ERROR_FALLBACK.
 155  * Without this flag those calls will never return
 156  * HWCRYPTOHOOK_ERROR_FALLBACK.  The flag will also cause the crypto
 157  * provider to avoid repeatedly attempting to contact dead hardware
 158  * within a short interval, if appropriate.
 159  */
 160
 161 #define HWCryptoHook_InitFlags_SimpleForkCheck   0x0010UL
 162 /*-
 163  * Without _SimpleForkCheck the library is allowed to assume that the
 164  * application will not fork and call the library in the child(ren).
 165  *
 166  * When it is specified, this is allowed.  However, after a fork
 167  * neither parent nor child may unload any loaded keys or call
 168  * _Finish.  Instead, they should call exit (or die with a signal)
 169  * without calling _Finish.  After all the children have died the
 170  * parent may unload keys or call _Finish.
 171  *
 172  * This flag only has any effect on UN*X platforms.
 173  */
 174
 175 typedef struct {
 176   unsigned long flags;
 177   void *logstream; /* usually a FILE*.  See below. */
 178
 179   size_t limbsize; /* bignum format - size of radix type, must be power of 2 */
 180   int mslimbfirst; /* 0 or 1 */
 181   int msbytefirst; /* 0 or 1; -1 = native */
 182
 183   /*-
 184    * All the callback functions should return 0 on success, or a
 185    * nonzero integer (whose value will be visible in the error message
 186    * put in the buffer passed to the call).
 187    *
 188    * If a callback is not available pass a null function pointer.
 189    *
 190    * The callbacks may not call down again into the crypto plugin.
 191    */
 192
 193   /*-
 194    * For thread-safety.  Set everything to 0 if you promise only to be
 195    * singlethreaded.  maxsimultaneous is the number of calls to
 196    * ModExp[Crt]/RSAImmed{Priv,Pub}/RSA.  If you don't know what to
 197    * put there then say 0 and the hook library will use a default.
 198    *
 199    * maxmutexes is a small limit on the number of simultaneous mutexes
 200    * which will be requested by the library.  If there is no small
 201    * limit, set it to 0.  If the crypto plugin cannot create the
 202    * advertised number of mutexes the calls to its functions may fail.
 203    * If a low number of mutexes is advertised the plugin will try to
 204    * do the best it can.  Making larger numbers of mutexes available
 205    * may improve performance and parallelism by reducing contention
 206    * over critical sections.  Unavailability of any mutexes, implying
 207    * single-threaded operation, should be indicated by the setting
 208    * mutex_init et al to 0.
 209    */
 210   int maxmutexes;
 211   int maxsimultaneous;
 212   size_t mutexsize;
 213   int (*mutex_init)(HWCryptoHook_Mutex*, HWCryptoHook_CallerContext *cactx);
 214   int (*mutex_acquire)(HWCryptoHook_Mutex*);
 215   void (*mutex_release)(HWCryptoHook_Mutex*);
 216   void (*mutex_destroy)(HWCryptoHook_Mutex*);
 217
 218   /*-
 219    * For greater efficiency, can use condition vars internally for
 220    * synchronisation.  In this case maxsimultaneous is ignored, but
 221    * the other mutex stuff must be available.  In singlethreaded
 222    * programs, set everything to 0.
 223    */
 224   size_t condvarsize;
 225   int (*condvar_init)(HWCryptoHook_CondVar*, HWCryptoHook_CallerContext *cactx);
 226   int (*condvar_wait)(HWCryptoHook_CondVar*, HWCryptoHook_Mutex*);
 227   void (*condvar_signal)(HWCryptoHook_CondVar*);
 228   void (*condvar_broadcast)(HWCryptoHook_CondVar*);
 229   void (*condvar_destroy)(HWCryptoHook_CondVar*);
 230
 231   /*-
 232    * The semantics of acquiring and releasing mutexes and broadcasting
 233    * and waiting on condition variables are expected to be those from
 234    * POSIX threads (pthreads).  The mutexes may be (in pthread-speak)
 235    * fast mutexes, recursive mutexes, or nonrecursive ones.
 236    *
 237    * The _release/_signal/_broadcast and _destroy functions must
 238    * always succeed when given a valid argument; if they are given an
 239    * invalid argument then the program (crypto plugin + application)
 240    * has an internal error, and they should abort the program.
 241    */
 242
 243   int (*getpassphrase)(const char *prompt_info,
 244                        int *len_io, char *buf,
 245                        HWCryptoHook_PassphraseContext *ppctx,
 246                        HWCryptoHook_CallerContext *cactx);
 247   /*-
 248    * Passphrases and the prompt_info, if they contain high-bit-set
 249    * characters, are UTF-8.  The prompt_info may be a null pointer if
 250    * no prompt information is available (it should not be an empty
 251    * string).  It will not contain text like `enter passphrase';
 252    * instead it might say something like `Operator Card for John
 253    * Smith' or `SmartCard in nFast Module #1, Slot #1'.
 254    *
 255    * buf points to a buffer in which to return the passphrase; on
 256    * entry *len_io is the length of the buffer.  It should be updated
 257    * by the callback.  The returned passphrase should not be
 258    * null-terminated by the callback.
 259    */
 260
 261   int (*getphystoken)(const char *prompt_info,
 262                       const char *wrong_info,
 263                       HWCryptoHook_PassphraseContext *ppctx,
 264                       HWCryptoHook_CallerContext *cactx);
 265   /*-
 266    * Requests that the human user physically insert a different
 267    * smartcard, DataKey, etc.  The plugin should check whether the
 268    * currently inserted token(s) are appropriate, and if they are it
 269    * should not make this call.
 270    *
 271    * prompt_info is as before.  wrong_info is a description of the
 272    * currently inserted token(s) so that the user is told what
 273    * something is.  wrong_info, like prompt_info, may be null, but
 274    * should not be an empty string.  Its contents should be
 275    * syntactically similar to that of prompt_info.
 276    */
 277
 278   /*-
 279    * Note that a single LoadKey operation might cause several calls to
 280    * getpassphrase and/or requestphystoken.  If requestphystoken is
 281    * not provided (ie, a null pointer is passed) then the plugin may
 282    * not support loading keys for which authorisation by several cards
 283    * is required.  If getpassphrase is not provided then cards with
 284    * passphrases may not be supported.
 285    *
 286    * getpassphrase and getphystoken do not need to check that the
 287    * passphrase has been entered correctly or the correct token
 288    * inserted; the crypto plugin will do that.  If this is not the
 289    * case then the crypto plugin is responsible for calling these
 290    * routines again as appropriate until the correct token(s) and
 291    * passphrase(s) are supplied as required, or until any retry limits
 292    * implemented by the crypto plugin are reached.
 293    *
 294    * In either case, the application must allow the user to say `no'
 295    * or `cancel' to indicate that they do not know the passphrase or
 296    * have the appropriate token; this should cause the callback to
 297    * return nonzero indicating error.
 298    */
 299
 300   void (*logmessage)(void *logstream, const char *message);
 301   /*-
 302    * A log message will be generated at least every time something goes
 303    * wrong and an ErrMsgBuf is filled in (or would be if one was
 304    * provided).  Other diagnostic information may be written there too,
 305    * including more detailed reasons for errors which are reported in an
 306    * ErrMsgBuf.
 307    *
 308    * When a log message is generated, this callback is called.  It
 309    * should write a message to the relevant logging arrangements.
 310    *
 311    * The message string passed will be null-terminated and may be of arbitrary
 312    * length.  It will not be prefixed by the time and date, nor by the
 313    * name of the library that is generating it - if this is required,
 314    * the logmessage callback must do it.  The message will not have a
 315    * trailing newline (though it may contain internal newlines).
 316    *
 317    * If a null pointer is passed for logmessage a default function is
 318    * used.  The default function treats logstream as a FILE* which has
 319    * been converted to a void*.  If logstream is 0 it does nothing.
 320    * Otherwise it prepends the date and time and library name and
 321    * writes the message to logstream.  Each line will be prefixed by a
 322    * descriptive string containing the date, time and identity of the
 323    * crypto plugin.  Errors on the logstream are not reported
 324    * anywhere, and the default function doesn't flush the stream, so
 325    * the application must set the buffering how it wants it.
 326    *
 327    * The crypto plugin may also provide a facility to have copies of
 328    * log messages sent elsewhere, and or for adjusting the verbosity
 329    * of the log messages; any such facilities will be configured by
 330    * external means.
 331    */
 332
 333 } HWCryptoHook_InitInfo;
 334
 335 typedef
 336 HWCryptoHook_ContextHandle HWCryptoHook_Init_t(const HWCryptoHook_InitInfo *initinfo,
 337                                                size_t initinfosize,
 338                                                const HWCryptoHook_ErrMsgBuf *errors,
 339                                                HWCryptoHook_CallerContext *cactx);
 340 extern HWCryptoHook_Init_t HWCryptoHook_Init;
 341
 342 /*-
 343  * Caller should set initinfosize to the size of the HWCryptoHook struct,
 344  * so it can be extended later.
 345  *
 346  * On success, a message for display or logging by the server,
 347  * including the name and version number of the plugin, will be filled
 348  * in into *errors; on failure *errors is used for error handling, as
 349  * usual.
 350  */
 351
 352 /*-
 353  * All these functions return 0 on success, HWCRYPTOHOOK_ERROR_FAILED
 354  * on most failures.  HWCRYPTOHOOK_ERROR_MPISIZE means at least one of
 355  * the output MPI buffer(s) was too small; the sizes of all have been
 356  * set to the desired size (and for those where the buffer was large
 357  * enough, the value may have been copied in), and no error message
 358  * has been recorded.
 359  *
 360  * You may pass 0 for the errors struct.  In any case, unless you set
 361  * _NoStderr at init time then messages may be reported to stderr.
 362  */
 363
 364 /*-
 365  * The RSAImmed* functions (and key managed RSA) only work with
 366  * modules which have an RSA patent licence - currently that means KM
 367  * units; the ModExp* ones work with all modules, so you need a patent
 368  * licence in the software in the US.  They are otherwise identical.
 369  */
 370
 371 typedef
 372 void HWCryptoHook_Finish_t(HWCryptoHook_ContextHandle hwctx);
 373 extern HWCryptoHook_Finish_t HWCryptoHook_Finish;
 374 /* You must not have any calls going or keys loaded when you call this. */
 375
 376 typedef
 377 int HWCryptoHook_RandomBytes_t(HWCryptoHook_ContextHandle hwctx,
 378                                unsigned char *buf, size_t len,
 379                                const HWCryptoHook_ErrMsgBuf *errors);
 380 extern HWCryptoHook_RandomBytes_t HWCryptoHook_RandomBytes;
 381
 382 typedef
 383 int HWCryptoHook_ModExp_t(HWCryptoHook_ContextHandle hwctx,
 384                           HWCryptoHook_MPI a,
 385                           HWCryptoHook_MPI p,
 386                           HWCryptoHook_MPI n,
 387                           HWCryptoHook_MPI *r,
 388                           const HWCryptoHook_ErrMsgBuf *errors);
 389 extern HWCryptoHook_ModExp_t HWCryptoHook_ModExp;
 390
 391 typedef
 392 int HWCryptoHook_RSAImmedPub_t(HWCryptoHook_ContextHandle hwctx,
 393                                HWCryptoHook_MPI m,
 394                                HWCryptoHook_MPI e,
 395                                HWCryptoHook_MPI n,
 396                                HWCryptoHook_MPI *r,
 397                                const HWCryptoHook_ErrMsgBuf *errors);
 398 extern HWCryptoHook_RSAImmedPub_t HWCryptoHook_RSAImmedPub;
 399
 400 typedef
 401 int HWCryptoHook_ModExpCRT_t(HWCryptoHook_ContextHandle hwctx,
 402                              HWCryptoHook_MPI a,
 403                              HWCryptoHook_MPI p,
 404                              HWCryptoHook_MPI q,
 405                              HWCryptoHook_MPI dmp1,
 406                              HWCryptoHook_MPI dmq1,
 407                              HWCryptoHook_MPI iqmp,
 408                              HWCryptoHook_MPI *r,
 409                              const HWCryptoHook_ErrMsgBuf *errors);
 410 extern HWCryptoHook_ModExpCRT_t HWCryptoHook_ModExpCRT;
 411
 412 typedef
 413 int HWCryptoHook_RSAImmedPriv_t(HWCryptoHook_ContextHandle hwctx,
 414                                 HWCryptoHook_MPI m,
 415                                 HWCryptoHook_MPI p,
 416                                 HWCryptoHook_MPI q,
 417                                 HWCryptoHook_MPI dmp1,
 418                                 HWCryptoHook_MPI dmq1,
 419                                 HWCryptoHook_MPI iqmp,
 420                                 HWCryptoHook_MPI *r,
 421                                 const HWCryptoHook_ErrMsgBuf *errors);
 422 extern HWCryptoHook_RSAImmedPriv_t HWCryptoHook_RSAImmedPriv;
 423
 424 /*-
 425  * The RSAImmed* and ModExp* functions may return E_FAILED or
 426  * E_FALLBACK for failure.
 427  *
 428  * E_FAILED means the failure is permanent and definite and there
 429  *    should be no attempt to fall back to software.  (Eg, for some
 430  *    applications, which support only the acceleration-only
 431  *    functions, the `key material' may actually be an encoded key
 432  *    identifier, and doing the operation in software would give wrong
 433  *    answers.)
 434  *
 435  * E_FALLBACK means that doing the computation in software would seem
 436  *    reasonable.  If an application pays attention to this and is
 437  *    able to fall back, it should also set the Fallback init flags.
 438  */
 439
 440 typedef
 441 int HWCryptoHook_RSALoadKey_t(HWCryptoHook_ContextHandle hwctx,
 442                               const char *key_ident,
 443                               HWCryptoHook_RSAKeyHandle *keyhandle_r,
 444                               const HWCryptoHook_ErrMsgBuf *errors,
 445                               HWCryptoHook_PassphraseContext *ppctx);
 446 extern HWCryptoHook_RSALoadKey_t HWCryptoHook_RSALoadKey;
 447 /*-
 448  * The key_ident is a null-terminated string configured by the
 449  * user via the application's usual configuration mechanisms.
 450  * It is provided to the user by the crypto provider's key management
 451  * system.  The user must be able to enter at least any string of between
 452  * 1 and 1023 characters inclusive, consisting of printable 7-bit
 453  * ASCII characters.  The provider should avoid using
 454  * any characters except alphanumerics and the punctuation
 455  * characters  _ - + . / @ ~  (the user is expected to be able
 456  * to enter these without quoting).  The string may be case-sensitive.
 457  * The application may allow the user to enter other NULL-terminated strings,
 458  * and the provider must cope (returning an error if the string is not
 459  * valid).
 460  *
 461  * If the key does not exist, no error is recorded and 0 is returned;
 462  * keyhandle_r will be set to 0 instead of to a key handle.
 463  */
 464
 465 typedef
 466 int HWCryptoHook_RSAGetPublicKey_t(HWCryptoHook_RSAKeyHandle k,
 467                                    HWCryptoHook_MPI *n,
 468                                    HWCryptoHook_MPI *e,
 469                                    const HWCryptoHook_ErrMsgBuf *errors);
 470 extern HWCryptoHook_RSAGetPublicKey_t HWCryptoHook_RSAGetPublicKey;
 471 /*-
 472  * The crypto plugin will not store certificates.
 473  *
 474  * Although this function for acquiring the public key value is
 475  * provided, it is not the purpose of this API to deal fully with the
 476  * handling of the public key.
 477  *
 478  * It is expected that the crypto supplier's key generation program
 479  * will provide general facilities for producing X.509
 480  * self-certificates and certificate requests in PEM format.  These
 481  * will be given to the user so that they can configure them in the
 482  * application, send them to CAs, or whatever.
 483  *
 484  * In case this kind of certificate handling is not appropriate, the
 485  * crypto supplier's key generation program should be able to be
 486  * configured not to generate such a self-certificate or certificate
 487  * request.  Then the application will need to do all of this, and
 488  * will need to store and handle the public key and certificates
 489  * itself.
 490  */
 491
 492 typedef
 493 int HWCryptoHook_RSAUnloadKey_t(HWCryptoHook_RSAKeyHandle k,
 494                                 const HWCryptoHook_ErrMsgBuf *errors);
 495 extern HWCryptoHook_RSAUnloadKey_t HWCryptoHook_RSAUnloadKey;
 496 /* Might fail due to locking problems, or other serious internal problems. */
 497
 498 typedef
 499 int HWCryptoHook_RSA_t(HWCryptoHook_MPI m,
 500                        HWCryptoHook_RSAKeyHandle k,
 501                        HWCryptoHook_MPI *r,
 502                        const HWCryptoHook_ErrMsgBuf *errors);
 503 extern HWCryptoHook_RSA_t HWCryptoHook_RSA;
 504 /* RSA private key operation (sign or decrypt) - raw, unpadded. */
 505
 506 #endif /*HWCRYPTOHOOK_H*/