source4/heimdal/lib/otp/otp.h

   1 /*
   2  * Copyright (c) 1995 - 2000 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id$ */
  35
  36 #ifndef _OTP_H
  37 #define _OTP_H
  38
  39 #include <stdlib.h>
  40 #include <time.h>
  41
  42 enum {OTPKEYSIZE = 8};
  43
  44 typedef unsigned char OtpKey[OTPKEYSIZE];
  45
  46 #define OTP_MIN_PASSPHRASE 10
  47 #define OTP_MAX_PASSPHRASE 63
  48
  49 #define OTP_USER_TIMEOUT   120
  50 #define OTP_DB_TIMEOUT      60
  51
  52 #define OTP_HEXPREFIX "hex:"
  53 #define OTP_WORDPREFIX "word:"
  54
  55 typedef enum { OTP_ALG_MD4, OTP_ALG_MD5, OTP_ALG_SHA } OtpAlgID;
  56
  57 #define OTP_ALG_DEFAULT "md5"
  58
  59 typedef struct {
  60   OtpAlgID id;
  61   char *name;
  62   int hashsize;
  63   int (*hash)(const char *, size_t, unsigned char *);
  64   int (*init)(OtpKey, const char *, const char *);
  65   int (*next)(OtpKey);
  66 } OtpAlgorithm;
  67
  68 typedef struct {
  69   char *user;
  70   OtpAlgorithm *alg;
  71   unsigned n;
  72   char seed[17];
  73   OtpKey key;
  74   int challengep;
  75   time_t lock_time;
  76   char *err;
  77 } OtpContext;
  78
  79 OtpAlgorithm *otp_find_alg (char *);
  80 void otp_print_stddict (OtpKey, char *, size_t);
  81 void otp_print_hex (OtpKey, char *, size_t);
  82 void otp_print_stddict_extended (OtpKey, char *, size_t);
  83 void otp_print_hex_extended (OtpKey, char *, size_t);
  84 unsigned otp_checksum (OtpKey);
  85 int otp_parse_hex (OtpKey, const char *);
  86 int otp_parse_stddict (OtpKey, const char *);
  87 int otp_parse_altdict (OtpKey, const char *, OtpAlgorithm *);
  88 int otp_parse (OtpKey, const char *, OtpAlgorithm *);
  89 int otp_challenge (OtpContext *, char *, char *, size_t);
  90 int otp_verify_user (OtpContext *, const char *);
  91 int otp_verify_user_1 (OtpContext *, const char *);
  92 char *otp_error (OtpContext *);
  93
  94 void *otp_db_open (void);
  95 void otp_db_close (void *);
  96 int otp_put (void *, OtpContext *);
  97 int otp_get (void *, OtpContext *);
  98 int otp_simple_get (void *, OtpContext *);
  99 int otp_delete (void *, OtpContext *);
 100
 101 #endif /* _OTP_H */