source: openpam/trunk/modules/pam_oath/oath.h @ 626

Last change on this file since 626 was 626, checked in by Dag-Erling Smørgrav, 8 years ago

Implement otpauth URI parsing (untested)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.3 KB
Line 
1/*-
2 * Copyright (c) 2012-2013 Universitetet i Oslo
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote
14 *    products derived from this software without specific prior written
15 *    permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $Id: oath.h 626 2013-02-27 16:19:56Z des $
30 */
31
32#ifndef OATH_H_INCLUDED
33#define OATH_H_INCLUDED
34
35/*
36 * Maximum time step for TOTP: 10 minutes, which RFC 6238 cites as an
37 * example of an unreasonably large time step.
38 */
39#define OATH_MAX_TIMESTEP       600
40
41/*
42 * Maximum key length in bytes.  HMAC has a 64-byte block size; if the key
43 * K is longer than that, HMAC derives a new key K' = H(K).
44 */
45#define OATH_MAX_KEYLEN         64
46
47/* estimate of output length for base32 encoding / decoding */
48#define base32_enclen(l) (size_t)(((l + 4) / 5) * 8)
49#define base32_declen(l) (size_t)(((l + 7) / 8) * 5)
50
51/* base32 encoding / decoding */
52int base32_enc(const uint8_t *, size_t, char *, size_t *);
53int base32_dec(const char *, size_t, uint8_t *, size_t *);
54
55/* estimate of output length for base64 encoding / decoding */
56#define base64_enclen(l) (size_t)(((l + 2) / 3) * 4)
57#define base64_declen(l) (size_t)(((l + 3) / 4) * 3)
58
59/* base64 encoding / decoding */
60int base64_enc(const uint8_t *, size_t, char *, size_t *);
61int base64_dec(const char *, size_t, uint8_t *, size_t *);
62
63/* mode: hotp (event mode) or totp (time-synch mode) */
64enum oath_mode { om_undef, om_hotp, om_totp };
65
66/* hash function */
67enum oath_hash { oh_undef, oh_sha1, oh_sha256, oh_sha512, oh_md5 };
68
69/* key structure */
70struct oath_key {
71        /* mode and parameters */
72        enum oath_mode   mode;
73        unsigned int     digits;
74        uint64_t         counter;
75        unsigned int     timestep; /* in seconds */
76
77        /* hash algorithm */
78        enum oath_hash   hash;
79
80        /* label */
81        size_t           labellen; /* bytes incl. NUL */
82        char            *label;
83
84        /* key */
85        size_t           keylen; /* bytes */
86        uint8_t         *key;
87
88        /* buffer for label + NUL + key */
89        size_t           datalen; /* bytes */
90        uint8_t          data[];
91};
92
93unsigned int oath_hotp(const uint8_t *, size_t, uint64_t, unsigned int);
94unsigned int oath_totp(const uint8_t *, size_t, unsigned int);
95
96#endif
Note: See TracBrowser for help on using the repository browser.