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