blob: 215c8a4f2eac502b0fdcdfe086985f260b2c19f8 [file] [log] [blame]
Travis Geiselbrecht1d0df692008-09-01 02:26:09 -07001/*****************************************************************************
2* pap.h - PPP Password Authentication Protocol header file.
3*
4* Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
5* portions Copyright (c) 1997 Global Election Systems Inc.
6*
7* The authors hereby grant permission to use, copy, modify, distribute,
8* and license this software and its documentation for any purpose, provided
9* that existing copyright notices are retained in all copies and that this
10* notice and the following disclaimer are included verbatim in any
11* distributions. No written agreement, license, or royalty fee is required
12* for any of the authorized uses.
13*
14* THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
15* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17* IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
18* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24*
25******************************************************************************
26* REVISION HISTORY
27*
28* 03-01-01 Marc Boucher <marc@mbsi.ca>
29* Ported to lwIP.
30* 97-12-04 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
31* Original derived from BSD codes.
32*****************************************************************************/
33/*
34 * upap.h - User/Password Authentication Protocol definitions.
35 *
36 * Copyright (c) 1989 Carnegie Mellon University.
37 * All rights reserved.
38 *
39 * Redistribution and use in source and binary forms are permitted
40 * provided that the above copyright notice and this paragraph are
41 * duplicated in all such forms and that any documentation,
42 * advertising materials, and other materials related to such
43 * distribution and use acknowledge that the software was developed
44 * by Carnegie Mellon University. The name of the
45 * University may not be used to endorse or promote products derived
46 * from this software without specific prior written permission.
47 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
48 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
49 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
50 */
51
52
53#ifndef PAP_H
54#define PAP_H
55
56/*************************
57*** PUBLIC DEFINITIONS ***
58*************************/
59/*
60 * Packet header = Code, id, length.
61 */
62#define UPAP_HEADERLEN (sizeof (u_char) + sizeof (u_char) + sizeof (u_short))
63
64
65/*
66 * UPAP codes.
67 */
68#define UPAP_AUTHREQ 1 /* Authenticate-Request */
69#define UPAP_AUTHACK 2 /* Authenticate-Ack */
70#define UPAP_AUTHNAK 3 /* Authenticate-Nak */
71
72/*
73 * Client states.
74 */
75#define UPAPCS_INITIAL 0 /* Connection down */
76#define UPAPCS_CLOSED 1 /* Connection up, haven't requested auth */
77#define UPAPCS_PENDING 2 /* Connection down, have requested auth */
78#define UPAPCS_AUTHREQ 3 /* We've sent an Authenticate-Request */
79#define UPAPCS_OPEN 4 /* We've received an Ack */
80#define UPAPCS_BADAUTH 5 /* We've received a Nak */
81
82/*
83 * Server states.
84 */
85#define UPAPSS_INITIAL 0 /* Connection down */
86#define UPAPSS_CLOSED 1 /* Connection up, haven't requested auth */
87#define UPAPSS_PENDING 2 /* Connection down, have requested auth */
88#define UPAPSS_LISTEN 3 /* Listening for an Authenticate */
89#define UPAPSS_OPEN 4 /* We've sent an Ack */
90#define UPAPSS_BADAUTH 5 /* We've sent a Nak */
91
92
93/************************
94*** PUBLIC DATA TYPES ***
95************************/
96
97/*
98 * Each interface is described by upap structure.
99 */
100typedef struct upap_state {
101 int us_unit; /* Interface unit number */
102 const char *us_user; /* User */
103 int us_userlen; /* User length */
104 const char *us_passwd; /* Password */
105 int us_passwdlen; /* Password length */
106 int us_clientstate; /* Client state */
107 int us_serverstate; /* Server state */
108 u_char us_id; /* Current id */
109 int us_timeouttime; /* Timeout (seconds) for auth-req retrans. */
110 int us_transmits; /* Number of auth-reqs sent */
111 int us_maxtransmits; /* Maximum number of auth-reqs to send */
112 int us_reqtimeout; /* Time to wait for auth-req from peer */
113} upap_state;
114
115
116/***********************
117*** PUBLIC FUNCTIONS ***
118***********************/
119
120extern upap_state upap[];
121
122void upap_setloginpasswd(int unit, const char *luser, const char *lpassword);
123void upap_authwithpeer (int, char *, char *);
124void upap_authpeer (int);
125
126extern struct protent pap_protent;
127
128#endif /* PAP_H */
129