pppd/session.h

   1 /*
   2  * session.c - PPP session control.
   3  *
   4  * Copyright (c) 2007 Diego Rivera. 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. The name(s) of the authors of this software must not be used to
  14  *    endorse or promote products derived from this software without
  15  *    prior written permission.
  16  *
  17  * 3. Redistributions of any form whatsoever must retain the following
  18  *    acknowledgment:
  19  *    "This product includes software developed by Paul Mackerras
  20  *     <paulus@samba.org>".
  21  *
  22  * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
  23  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  24  * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  25  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  26  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  27  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  28  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  29  */
  30 #include "pppdconf.h"
  31
  32 #ifndef __SESSION_H
  33 #define __SESSION_H
  34
  35 #define SESS_AUTH  1    /* Check User Authentication */
  36 #define SESS_ACCT  2    /* Check Account Validity */
  37
  38 /* Convenience parameter to do the whole enchilada */
  39 #define SESS_ALL   (SESS_AUTH | SESS_ACCT)
  40
  41 /*
  42  * int session_start(...)
  43  *
  44  * Start a session, performing any necessary validations.
  45  *
  46  * Parameters:
  47  *      const int flags :
  48  *              Any combination of the SESS_XXX flags, to indicate what the function
  49  *              should do as part of its checks
  50  *
  51  *      const char* user :
  52  *              The username to validate.  May safely be null.
  53  *
  54  *      const char* passwd :
  55  *              The password to validate the user with. May safely be null.
  56  *
  57  *      const char* tty :
  58  *              The TTY the user is connected on. May safely be null.
  59  *
  60  *      char** msg :
  61  *              A char* to return an error or success message.  This message will be returned
  62  *              regardless of the result.  May safely be null.
  63  *
  64  * Return Value:
  65  *      Zero value for failure, non-zero value for successful session verification.
  66  */
  67 int
  68 session_start(const int flags, const char* user, const char* passwd, const char* tty, char** msg);
  69
  70 /* Added these macros for convenience... */
  71 #define session_auth(user, pass, tty, msg) \
  72         session_start(SESS_AUTH, user, pass, tty, msg)
  73
  74 #define session_check(user, pass, tty, msg) \
  75         session_start(SESS_ACCT, user, pass, tty, msg)
  76
  77 #define session_full(user, pass, tty, msg) \
  78         session_start(SESS_ALL, user, pass, tty, msg)
  79
  80 /*
  81  * void session_end(...)
  82  *
  83  * End a previously-started session.
  84  *
  85  * Parameters:
  86  *      const char* tty :
  87  *              The TTY the user is connected on. May safely be null.
  88  */
  89 void
  90 session_end(const char* tty);
  91
  92 #endif