xref: /freebsd/usr.sbin/ppp/auth.h (revision b3e76948)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1996 - 2001 Brian Somers <brian@Awfulhak.org>
5  *          based on work by Toshiharu OHNO <tony-o@iij.ad.jp>
6  *                           Internet Initiative Japan, Inc (IIJ)
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 struct physical;
32 struct bundle;
33 struct authinfo;
34 typedef void (*auth_func)(struct authinfo *);
35 
36 struct authinfo {
37   struct {
38     auth_func req;
39     auth_func success;
40     auth_func failure;
41   } fn;
42   struct {
43     struct fsmheader hdr;
44     char name[AUTHLEN];
45   } in;
46   struct pppTimer authtimer;
47   int retry;
48   int id;
49   struct physical *physical;
50   struct {
51     struct fsm_retry fsm;	/* How often/frequently to resend requests */
52   } cfg;
53 };
54 
55 #define auth_Failure(a) (*(a)->fn.failure)(a)
56 #define auth_Success(a) (*(a)->fn.success)(a)
57 
58 extern const char *Auth2Nam(u_short, u_char);
59 extern void auth_Init(struct authinfo *, struct physical *,
60                       auth_func, auth_func, auth_func);
61 extern void auth_StopTimer(struct authinfo *);
62 extern void auth_StartReq(struct authinfo *);
63 extern int auth_Validate(struct bundle *, const char *, const char *);
64 extern char *auth_GetSecret(const char *, size_t);
65 extern int auth_SetPhoneList(const char *, char *, int);
66 extern int auth_Select(struct bundle *, const char *);
67 extern struct mbuf *auth_ReadHeader(struct authinfo *, struct mbuf *);
68 extern struct mbuf *auth_ReadName(struct authinfo *, struct mbuf *, size_t);
69