loginrec.h

   1 #ifndef _HAVE_LOGINREC_H_
   2 #define _HAVE_LOGINREC_H_
   3
   4 /*
   5  * Copyright (c) 2000 Andre Lucas.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  ** loginrec.h:  platform-independent login recording and lastlog retrieval
  30  **/
  31
  32 #include "includes.h"
  33
  34 #include <sys/types.h>
  35 #include <netinet/in.h>
  36 #include <sys/socket.h>
  37
  38 /**
  39  ** you should use the login_* calls to work around platform dependencies
  40  **/
  41
  42 /*
  43  * login_netinfo structure
  44  */
  45
  46 union login_netinfo {
  47         struct sockaddr sa;
  48         struct sockaddr_in sa_in;
  49         struct sockaddr_storage sa_storage;
  50 };
  51
  52 /*
  53  *   * logininfo structure  *
  54  */
  55 /* types - different to utmp.h 'type' macros */
  56 /* (though set to the same value as linux, openbsd and others...) */
  57 #define LTYPE_LOGIN    7
  58 #define LTYPE_LOGOUT   8
  59
  60 /* string lengths - set very long */
  61 #define LINFO_PROGSIZE 64
  62 #define LINFO_LINESIZE 64
  63 #define LINFO_NAMESIZE 128
  64 #define LINFO_HOSTSIZE 256
  65
  66 struct logininfo {
  67         char       progname[LINFO_PROGSIZE];     /* name of program (for PAM) */
  68         int        progname_null;
  69         short int  type;                         /* type of login (LTYPE_*) */
  70         int        pid;                          /* PID of login process */
  71         int        uid;                          /* UID of this user */
  72         char       line[LINFO_LINESIZE];         /* tty/pty name */
  73         char       username[LINFO_NAMESIZE];     /* login username */
  74         char       hostname[LINFO_HOSTSIZE];     /* remote hostname */
  75         /* 'exit_status' structure components */
  76         int        exit;                        /* process exit status */
  77         int        termination;                 /* process termination status */
  78         /* struct timeval (sys/time.h) isn't always available, if it isn't we'll
  79          * use time_t's value as tv_sec and set tv_usec to 0
  80          */
  81         unsigned int tv_sec;
  82         unsigned int tv_usec;
  83         union login_netinfo hostaddr;       /* caller's host address(es) */
  84 }; /* struct logininfo */
  85
  86 /*
  87  * login recording functions
  88  */
  89
  90 /** 'public' functions */
  91
  92 /* construct a new login entry */
  93 struct logininfo *login_alloc_entry(int pid, const char *username,
  94                                     const char *hostname, const char *line);
  95 /* free a structure */
  96 void login_free_entry(struct logininfo *li);
  97 /* fill out a pre-allocated structure with useful information */
  98 int login_init_entry(struct logininfo *li, int pid, const char *username,
  99                      const char *hostname, const char *line);
 100 /* place the current time in a logininfo struct */
 101 void login_set_current_time(struct logininfo *li);
 102
 103 /* record the entry */
 104 int login_login (struct logininfo *li);
 105 int login_logout(struct logininfo *li);
 106 #ifdef LOGIN_NEEDS_UTMPX
 107 int login_utmp_only(struct logininfo *li);
 108 #endif
 109
 110 /** End of public functions */
 111
 112 /* record the entry */
 113 int login_write (struct logininfo *li);
 114 int login_log_entry(struct logininfo *li);
 115
 116 /* set the network address based on network address type */
 117 void login_set_addr(struct logininfo *li, const struct sockaddr *sa,
 118                     const unsigned int sa_size);
 119
 120 /*
 121  * lastlog retrieval functions
 122  */
 123 /* lastlog *entry* functions fill out a logininfo */
 124 struct logininfo *login_get_lastlog(struct logininfo *li, const int uid);
 125 /* lastlog *time* functions return time_t equivalent (uint) */
 126 unsigned int login_get_lastlog_time(const int uid);
 127
 128 /* produce various forms of the line filename */
 129 char *line_fullname(char *dst, const char *src, u_int dstsize);
 130 char *line_stripname(char *dst, const char *src, int dstsize);
 131 char *line_abbrevname(char *dst, const char *src, int dstsize);
 132
 133 void record_failed_login(const char *, const char *, const char *);
 134
 135 #endif /* _HAVE_LOGINREC_H_ */