import from HEAD
[freeradius.git] / src / modules / rlm_otp / otp.h
index 8bcc0a9..defe016 100644 (file)
@@ -1,5 +1,4 @@
 /*
- * otp.h
  * $Id$
  *
  *   This program is free software; you can redistribute it and/or modify
  *
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
- *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  *
- * Copyright 2001-2005 Google, Inc.
- * Copyright 2005 Frank Cusack
+ * Copyright 2005,2006 TRI-D Systems, Inc.
  */
 
 #ifndef OTP_H
 #define OTP_H
 
-#ifndef _REENTRANT
-#define _REENTRANT
-#endif
-#include <pthread.h>
-
-#include <inttypes.h>
-#include <openssl/des.h> /* des_cblock */
-#include <time.h>        /* time_t */
-
-/*
- * Things you might like to change (although most are configurables)
- */
-
-/* Default passwd file */
-#define OTP_PWDFILE "/etc/otppasswd"
-
-/* state manager rendezvous point */
-#define OTP_LSMD_RP "/var/run/lsmd/socket"
-
-/* Default prompt for presentation of challenge */
-#define OTP_CHALLENGE_PROMPT "Challenge: %s\n Response: "
-
-/* Must be a multiple of sizeof(des_cblock) (8); read src before changing. */
-#define OTP_MAX_CHALLENGE_LEN 32
-
-/* Password that means "challenge me" in fast_sync mode */
-#define OTP_CHALLENGE_REQ "challenge"
-
-/* Password that means "challenge me and resync" in fast_sync mode */
-#define OTP_RESYNC_REQ "resync"
-
-/* Max event window size for sync modes */
-#define OTP_MAX_EWINDOW_SIZE 10
-/* Max time window size for sync modes.  More than 10 may not be usable. */
-#define OTP_MAX_TWINDOW_SIZE 10
-
-/*
- * PRNG device that does not block;
- * /dev/urandom is "merely" cryptographically strong on Linux. :-)
- */
-#define OTP_DEVURANDOM "/dev/urandom"
+#include "ident.h"
+RCSIDH(otp_h, "$Id$");
 
+#include <sys/types.h>
 
 /*
- * You shouldn't change anything past this point
+ * NOTE: This file must be synced between plugins and otpd.
  */
 
-
-/* struct used for instance/option data */
-typedef struct otp_option_t {
-    char *pwdfile;     /* file containing user:card_type:key entries      */
-    char *lsmd_rp;     /* state manager rendezvous point                  */
-    char *chal_prompt; /* text to present challenge to user, must have %s */
-    int chal_len;      /* challenge length, min 5 digits                  */
-    int softfail;      /* number of auth fails before time delay starts   */
-    int hardfail;      /* number of auth fails when user is locked out    */
-    int fast_sync;     /* response-before-challenge mode                  */
-    int allow_sync;    /* useful to override pwdfile card_type settings   */
-    int allow_async;   /* C/R mode allowed?                               */
-    char *chal_req;    /* keyword requesting challenge for fast_sync mode */
-    char *resync_req;  /* keyword requesting resync for fast_sync mode    */
-    int prepend_pin;   /* prepend (vs. append) PIN?                       */
-    int ewindow_size;  /* sync mode event window size (right side value)  */
-    int ewindow2_size; /* softfail override event window size             */
-    int ewindow2_delay;        /* softfail override max time delay                */
-#if defined(FREERADIUS)
-    /* freeradius-specific items */
-    int chal_delay;            /* max delay time for response, in seconds */
-    const char *name;          /* instance name for otp_token_authorize() */
-    int mschapv2_mppe_policy;  /* whether or not do to mppe for mschapv2  */
-    int mschapv2_mppe_types;   /* key type/length for mschapv2/mppe       */
-    int mschap_mppe_policy;    /* whether or not do to mppe for mschap    */
-    int mschap_mppe_types;     /* key type/length for mschap/mppe         */
-#elif defined(PAM)
-    /* PAM specific items */
-    int debug;         /* print debug info?                               */
-    char *fast_prompt; /* fast mode prompt                                */
+#ifndef OTP_MAX_CHALLENGE_LEN
+#define OTP_MAX_CHALLENGE_LEN  16
+#elif OTP_MAX_CHALLENGE_LEN != 16
+#error OTP_MAX_CHALLENGE_LEN
 #endif
-#if 0
-    int twindow_min;   /* sync mode time window left side                 */
-    int twindow_max;   /* sync mode time window right side                */
-#endif
-} otp_option_t;
-
-/* user-specific info */
-#define OTP_MAX_CARDNAME_LEN 32
-#define OTP_MAX_KEY_LEN 256
-#define OTP_MAX_PIN_LEN 256
-struct cardops_t;
-typedef struct otp_user_info_t {
-    const char *username;
-    struct cardops_t *cardops;
-
-    char card[OTP_MAX_CARDNAME_LEN + 1];
-    uint32_t featuremask;
-
-    char keystring[OTP_MAX_KEY_LEN * 2 + 1];
-    unsigned char keyblock[OTP_MAX_KEY_LEN];
-    char pin[OTP_MAX_PIN_LEN + 1];
-#if 0
-    void *keyschedule;
-#endif
-} otp_user_info_t;
-
-/* user-specific state info */
-#define OTP_MAX_CSD_LEN 64
-typedef struct otp_user_state_t {
-    int                locked;                 /* locked aka success flag        */
-    int                *fdp;                   /* fd for return data             */
-    int                updated;                /* state updated? (1 unless err)  */
-    char       challenge[OTP_MAX_CHALLENGE_LEN+1];     /* next sync chal */
-    char       csd[OTP_MAX_CSD_LEN+1]; /* card specific data             */
-    unsigned   failcount;              /* number of consecutive failures */
-    time_t     authtime;               /* time of last auth              */
-    int                authpos;                /* window position for softfail   */
-} otp_user_state_t;
 
-/* fc (failcondition) shortcuts */
-#define OTP_FC_FAIL_NONE 0     /* no failures */
-#define OTP_FC_FAIL_HARD 1     /* failed hard */
-#define OTP_FC_FAIL_SOFT 2     /* failed soft */
-
-/* otp_cardops.c */
-/* return codes from otp_pw_valid() */
 #define OTP_RC_OK              0
 #define OTP_RC_USER_UNKNOWN    1
 #define OTP_RC_AUTHINFO_UNAVAIL        2
 #define OTP_RC_AUTH_ERR                3
 #define OTP_RC_MAXTRIES                4
 #define OTP_RC_SERVICE_ERR     5
-struct otp_pwe_cmp_t;
-typedef int (*cmpfunc_t)(struct otp_pwe_cmp_t *data, const char *passcode);
-extern int otp_pw_valid(const char *username,
-                       char *challenge, const char *passcode,
-                       int resync, const otp_option_t *opt,
-                       cmpfunc_t cmpfunc, void *data,
-                       const char *log_prefix);
-
-/* otp_x99.c */
-extern int otp_x99_mac(const unsigned char *input, size_t len,
-                      unsigned char output[8],
-                      const unsigned char keyblock[OTP_MAX_KEY_LEN]);
 
-/* otp_util.c */
-/* Character maps for generic hex and vendor specific decimal modes */
-extern const char otp_hex_conversion[];
-extern const char otp_cc_dec_conversion[];
-extern const char otp_snk_dec_conversion[];
-extern const char otp_sc_friendly_conversion[];
-
-extern int otp_get_random(int fd, unsigned char *rnd_data, int req_bytes);
-extern int otp_get_challenge(int fd, char *challenge, int len);
-
-extern int otp_keystring2keyblock(const char *s, unsigned char keyblock[]);
-extern void otp_keyblock2keystring(char *s, const des_cblock keyblock,
-                                  const char conversion[17]);
-
-extern int otp_get_user_info(const char *pwdfile, const char *username,
-                            otp_user_info_t *user_info);
-
-/* otp_state.c */
-extern int otp_state_get(const otp_option_t *opt, const char *username,
-                        otp_user_state_t *user_state, const char *log_prefix);
-extern int otp_state_put(const char *username, otp_user_state_t *user_state,
-                        const char *log_prefix);
-
-/* otp_site.c */
-extern int otp_challenge_transform(const char *username,
-                                  char challenge[OTP_MAX_CHALLENGE_LEN + 1]);
-
-/* otp_log.c */
-extern void otp_log(int level, const char *format, ...);
-
-#if defined(FREERADIUS)
-#include "otp_rad.h"
-#elif defined(PAM)
-#include "otp_pam.h"
-#endif
+#define OTP_MAX_USERNAME_LEN           31
+#define OTP_MAX_PASSCODE_LEN           47
+#define OTP_MAX_CHAP_CHALLENGE_LEN     16
+#define OTP_MAX_CHAP_RESPONSE_LEN      50
+
+typedef enum otp_pwe_t {
+  PWE_PAP = 1,
+  PWE_CHAP = 3,
+  PWE_MSCHAP = 5,
+  PWE_MSCHAP2 = 7,
+} otp_pwe_t;
+
+typedef struct otp_request_t {
+  int  version;                                        /* 1 */
+  char username[OTP_MAX_USERNAME_LEN + 1];
+  char challenge[OTP_MAX_CHALLENGE_LEN + 1];           /* USER challenge */
+  struct {
+    otp_pwe_t    pwe;
+    char         passcode[OTP_MAX_PASSCODE_LEN + 1];
+    unsigned char challenge[OTP_MAX_CHAP_CHALLENGE_LEN]; /* CHAP challenge */
+    size_t       clen;
+    unsigned char response[OTP_MAX_CHAP_RESPONSE_LEN];
+    size_t       rlen;
+  } pwe;
+  int          allow_async;            /* async auth allowed?           */
+  int          allow_sync;             /* sync auth allowed?            */
+  unsigned     challenge_delay;        /* min delay between async auths */
+  int          resync;                 /* resync on async auth?         */
+} otp_request_t;
+
+typedef struct otp_reply_t {
+  int  version;                                        /* 1 */
+  int  rc;
+  char passcode[OTP_MAX_PASSCODE_LEN + 1];
+} otp_reply_t;
 
 #endif /* OTP_H */