blob: 7f932c2966f4819a0d98ffc6bbb4e2b9f5f77e6a [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.
andre2ff7b5d2000-06-03 14:57:40 +000015 *
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
Kevin Stevesef4eea92001-02-05 12:42:17 +000028/**
andre2ff7b5d2000-06-03 14:57:40 +000029 ** 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
Damien Miller638733e2003-06-03 12:18:50 +100038/* RCSID("$Id: loginrec.h,v 1.7 2003/06/03 02:18:50 djm Exp $"); */
andre2ff7b5d2000-06-03 14:57:40 +000039
40/**
41 ** you should use the login_* calls to work around platform dependencies
42 **/
43
andre2ff7b5d2000-06-03 14:57:40 +000044/*
45 * login_netinfo structure
46 */
47
andre61e67252000-06-04 17:07:49 +000048union login_netinfo {
49 struct sockaddr sa;
50 struct sockaddr_in sa_in;
51 struct sockaddr_storage sa_storage;
52};
andre2ff7b5d2000-06-03 14:57:40 +000053
andre2ff7b5d2000-06-03 14:57:40 +000054/*
55 * * logininfo structure *
56 */
andre2ff7b5d2000-06-03 14:57:40 +000057/* types - different to utmp.h 'type' macros */
58/* (though set to the same value as linux, openbsd and others...) */
59#define LTYPE_LOGIN 7
60#define LTYPE_LOGOUT 8
61
62/* string lengths - set very long */
63#define LINFO_PROGSIZE 64
64#define LINFO_LINESIZE 64
65#define LINFO_NAMESIZE 64
66#define LINFO_HOSTSIZE 256
67
68struct logininfo {
andre2ff7b5d2000-06-03 14:57:40 +000069 char progname[LINFO_PROGSIZE]; /* name of program (for PAM) */
70 int progname_null;
andre2ff7b5d2000-06-03 14:57:40 +000071 short int type; /* type of login (LTYPE_*) */
andre2ff7b5d2000-06-03 14:57:40 +000072 int pid; /* PID of login process */
73 int uid; /* UID of this user */
74 char line[LINFO_LINESIZE]; /* tty/pty name */
75 char username[LINFO_NAMESIZE]; /* login username */
76 char hostname[LINFO_HOSTSIZE]; /* remote hostname */
andre2ff7b5d2000-06-03 14:57:40 +000077 /* 'exit_status' structure components */
78 int exit; /* process exit status */
79 int termination; /* process termination status */
andre2ff7b5d2000-06-03 14:57:40 +000080 /* struct timeval (sys/time.h) isn't always available, if it isn't we'll
81 * use time_t's value as tv_sec and set tv_usec to 0
82 */
83 unsigned int tv_sec;
Kevin Stevesef4eea92001-02-05 12:42:17 +000084 unsigned int tv_usec;
andre61e67252000-06-04 17:07:49 +000085 union login_netinfo hostaddr; /* caller's host address(es) */
andre2ff7b5d2000-06-03 14:57:40 +000086}; /* struct logininfo */
87
andre2ff7b5d2000-06-03 14:57:40 +000088/*
89 * login recording functions
90 */
andre6bb92372000-06-19 08:20:03 +000091
92/** 'public' functions */
93
andre2ff7b5d2000-06-03 14:57:40 +000094/* construct a new login entry */
andre61e67252000-06-04 17:07:49 +000095struct logininfo *login_alloc_entry(int pid, const char *username,
andre2ff7b5d2000-06-03 14:57:40 +000096 const char *hostname, const char *line);
andre61e67252000-06-04 17:07:49 +000097/* free a structure */
andre2ff7b5d2000-06-03 14:57:40 +000098void login_free_entry(struct logininfo *li);
andre61e67252000-06-04 17:07:49 +000099/* fill out a pre-allocated structure with useful information */
Kevin Stevesef4eea92001-02-05 12:42:17 +0000100int login_init_entry(struct logininfo *li, int pid, const char *username,
andre61e67252000-06-04 17:07:49 +0000101 const char *hostname, const char *line);
102/* place the current time in a logininfo struct */
andre2ff7b5d2000-06-03 14:57:40 +0000103void login_set_current_time(struct logininfo *li);
andre61e67252000-06-04 17:07:49 +0000104
andre6bb92372000-06-19 08:20:03 +0000105/* record the entry */
106int login_login (struct logininfo *li);
107int login_logout(struct logininfo *li);
Ben Lindstrom97c677d2001-05-08 20:33:05 +0000108#ifdef LOGIN_NEEDS_UTMPX
109int login_utmp_only(struct logininfo *li);
110#endif
andre6bb92372000-06-19 08:20:03 +0000111
112/** End of public functions */
andre61e67252000-06-04 17:07:49 +0000113
andre2ff7b5d2000-06-03 14:57:40 +0000114/* record the entry */
115int login_write (struct logininfo *li);
andre2ff7b5d2000-06-03 14:57:40 +0000116int login_log_entry(struct logininfo *li);
117
andre6bb92372000-06-19 08:20:03 +0000118/* set the network address based on network address type */
119void login_set_addr(struct logininfo *li, const struct sockaddr *sa,
120 const unsigned int sa_size);
121
andre2ff7b5d2000-06-03 14:57:40 +0000122/*
andre61e67252000-06-04 17:07:49 +0000123 * lastlog retrieval functions
andre2ff7b5d2000-06-03 14:57:40 +0000124 */
125/* lastlog *entry* functions fill out a logininfo */
andre61e67252000-06-04 17:07:49 +0000126struct logininfo *login_get_lastlog(struct logininfo *li, const int uid);
andre2ff7b5d2000-06-03 14:57:40 +0000127/* lastlog *time* functions return time_t equivalent (uint) */
andre61e67252000-06-04 17:07:49 +0000128unsigned int login_get_lastlog_time(const int uid);
andre2ff7b5d2000-06-03 14:57:40 +0000129
130/* produce various forms of the line filename */
131char *line_fullname(char *dst, const char *src, int dstsize);
132char *line_stripname(char *dst, const char *src, int dstsize);
133char *line_abbrevname(char *dst, const char *src, int dstsize);
134
andre2ff7b5d2000-06-03 14:57:40 +0000135#endif /* _HAVE_LOGINREC_H_ */