1 #ifndef _HAVE_LOGINREC_H_
2 #define _HAVE_LOGINREC_H_
5 * Copyright (c) 2000 Andre Lucas. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
34 ** loginrec.h: platform-independent login recording and lastlog retrieval
39 #include <sys/types.h>
40 #include <netinet/in.h>
41 #include <sys/socket.h>
46 ** you should use the login_* calls to work around platform dependencies
50 * login_netinfo structure
55 struct sockaddr_in sa_in;
56 struct sockaddr_storage sa_storage;
61 * * logininfo structure *
64 /* types - different to utmp.h 'type' macros */
65 /* (though set to the same value as linux, openbsd and others...) */
67 #define LTYPE_LOGOUT 8
69 /* string lengths - set very long */
70 #define LINFO_PROGSIZE 64
71 #define LINFO_LINESIZE 64
72 #define LINFO_NAMESIZE 64
73 #define LINFO_HOSTSIZE 256
77 char progname[LINFO_PROGSIZE]; /* name of program (for PAM) */
80 short int type; /* type of login (LTYPE_*) */
82 int pid; /* PID of login process */
83 int uid; /* UID of this user */
84 char line[LINFO_LINESIZE]; /* tty/pty name */
85 char username[LINFO_NAMESIZE]; /* login username */
86 char hostname[LINFO_HOSTSIZE]; /* remote hostname */
88 /* 'exit_status' structure components */
89 int exit; /* process exit status */
90 int termination; /* process termination status */
92 /* struct timeval (sys/time.h) isn't always available, if it isn't we'll
93 * use time_t's value as tv_sec and set tv_usec to 0
98 union login_netinfo hostaddr; /* caller's host address(es) */
99 }; /* struct logininfo */
103 * login recording functions
106 /** 'public' functions */
108 /* construct a new login entry */
109 struct logininfo *login_alloc_entry(int pid, const char *username,
110 const char *hostname, const char *line);
111 /* free a structure */
112 void login_free_entry(struct logininfo *li);
113 /* fill out a pre-allocated structure with useful information */
114 int login_init_entry(struct logininfo *li, int pid, const char *username,
115 const char *hostname, const char *line);
116 /* place the current time in a logininfo struct */
117 void login_set_current_time(struct logininfo *li);
119 /* record the entry */
120 int login_login (struct logininfo *li);
121 int login_logout(struct logininfo *li);
123 /** End of public functions */
125 /* record the entry */
126 int login_write (struct logininfo *li);
127 int login_log_entry(struct logininfo *li);
129 /* set the network address based on network address type */
130 void login_set_addr(struct logininfo *li, const struct sockaddr *sa,
131 const unsigned int sa_size);
134 * lastlog retrieval functions
136 /* lastlog *entry* functions fill out a logininfo */
137 struct logininfo *login_get_lastlog(struct logininfo *li, const int uid);
138 /* lastlog *time* functions return time_t equivalent (uint) */
139 unsigned int login_get_lastlog_time(const int uid);
141 /* produce various forms of the line filename */
142 char *line_fullname(char *dst, const char *src, int dstsize);
143 char *line_stripname(char *dst, const char *src, int dstsize);
144 char *line_abbrevname(char *dst, const char *src, int dstsize);
147 #endif /* _HAVE_LOGINREC_H_ */