blob: ecb430d50820c47e82f2feaa30acafd21c979f1d [file] [log] [blame]
andre2ff7b5d2000-06-03 14:57:40 +00001#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
Kevin Stevesef4eea92001-02-05 12:42:17 +000033/**
andre2ff7b5d2000-06-03 14:57:40 +000034 ** 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
Kevin Stevesef4eea92001-02-05 12:42:17 +000043/* RCSID("$Id: loginrec.h,v 1.5 2001/02/05 12:42:18 stevesk Exp $"); */
andre2ff7b5d2000-06-03 14:57:40 +000044
45/**
46 ** you should use the login_* calls to work around platform dependencies
47 **/
48
andre2ff7b5d2000-06-03 14:57:40 +000049/*
50 * login_netinfo structure
51 */
52
andre61e67252000-06-04 17:07:49 +000053union login_netinfo {
54 struct sockaddr sa;
55 struct sockaddr_in sa_in;
56 struct sockaddr_storage sa_storage;
57};
andre2ff7b5d2000-06-03 14:57:40 +000058
andre2ff7b5d2000-06-03 14:57:40 +000059/*
60 * * logininfo structure *
61 */
andre2ff7b5d2000-06-03 14:57:40 +000062/* 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
73struct logininfo {
andre2ff7b5d2000-06-03 14:57:40 +000074 char progname[LINFO_PROGSIZE]; /* name of program (for PAM) */
75 int progname_null;
andre2ff7b5d2000-06-03 14:57:40 +000076 short int type; /* type of login (LTYPE_*) */
andre2ff7b5d2000-06-03 14:57:40 +000077 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 */
andre2ff7b5d2000-06-03 14:57:40 +000082 /* 'exit_status' structure components */
83 int exit; /* process exit status */
84 int termination; /* process termination status */
andre2ff7b5d2000-06-03 14:57:40 +000085 /* 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;
Kevin Stevesef4eea92001-02-05 12:42:17 +000089 unsigned int tv_usec;
andre61e67252000-06-04 17:07:49 +000090 union login_netinfo hostaddr; /* caller's host address(es) */
andre2ff7b5d2000-06-03 14:57:40 +000091}; /* struct logininfo */
92
andre2ff7b5d2000-06-03 14:57:40 +000093/*
94 * login recording functions
95 */
andre6bb92372000-06-19 08:20:03 +000096
97/** 'public' functions */
98
andre2ff7b5d2000-06-03 14:57:40 +000099/* construct a new login entry */
andre61e67252000-06-04 17:07:49 +0000100struct logininfo *login_alloc_entry(int pid, const char *username,
andre2ff7b5d2000-06-03 14:57:40 +0000101 const char *hostname, const char *line);
andre61e67252000-06-04 17:07:49 +0000102/* free a structure */
andre2ff7b5d2000-06-03 14:57:40 +0000103void login_free_entry(struct logininfo *li);
andre61e67252000-06-04 17:07:49 +0000104/* fill out a pre-allocated structure with useful information */
Kevin Stevesef4eea92001-02-05 12:42:17 +0000105int login_init_entry(struct logininfo *li, int pid, const char *username,
andre61e67252000-06-04 17:07:49 +0000106 const char *hostname, const char *line);
107/* place the current time in a logininfo struct */
andre2ff7b5d2000-06-03 14:57:40 +0000108void login_set_current_time(struct logininfo *li);
andre61e67252000-06-04 17:07:49 +0000109
andre6bb92372000-06-19 08:20:03 +0000110/* record the entry */
111int login_login (struct logininfo *li);
112int login_logout(struct logininfo *li);
113
114/** End of public functions */
andre61e67252000-06-04 17:07:49 +0000115
andre2ff7b5d2000-06-03 14:57:40 +0000116/* record the entry */
117int login_write (struct logininfo *li);
andre2ff7b5d2000-06-03 14:57:40 +0000118int login_log_entry(struct logininfo *li);
119
andre6bb92372000-06-19 08:20:03 +0000120/* set the network address based on network address type */
121void login_set_addr(struct logininfo *li, const struct sockaddr *sa,
122 const unsigned int sa_size);
123
andre2ff7b5d2000-06-03 14:57:40 +0000124/*
andre61e67252000-06-04 17:07:49 +0000125 * lastlog retrieval functions
andre2ff7b5d2000-06-03 14:57:40 +0000126 */
127/* lastlog *entry* functions fill out a logininfo */
andre61e67252000-06-04 17:07:49 +0000128struct logininfo *login_get_lastlog(struct logininfo *li, const int uid);
andre2ff7b5d2000-06-03 14:57:40 +0000129/* lastlog *time* functions return time_t equivalent (uint) */
andre61e67252000-06-04 17:07:49 +0000130unsigned int login_get_lastlog_time(const int uid);
andre2ff7b5d2000-06-03 14:57:40 +0000131
132/* produce various forms of the line filename */
133char *line_fullname(char *dst, const char *src, int dstsize);
134char *line_stripname(char *dst, const char *src, int dstsize);
135char *line_abbrevname(char *dst, const char *src, int dstsize);
136
andre2ff7b5d2000-06-03 14:57:40 +0000137#endif /* _HAVE_LOGINREC_H_ */