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
34struct ssh;
35
36/**
37 ** you should use the login_* calls to work around platform dependencies
38 **/
39
40/*
41 * login_netinfo structure
42 */
43
44union login_netinfo {
45	struct sockaddr sa;
46	struct sockaddr_in sa_in;
47	struct sockaddr_storage sa_storage;
48};
49
50/*
51 *   * logininfo structure  *
52 */
53/* types - different to utmp.h 'type' macros */
54/* (though set to the same value as linux, openbsd and others...) */
55#define LTYPE_LOGIN    7
56#define LTYPE_LOGOUT   8
57
58/* string lengths - set very long */
59#define LINFO_PROGSIZE 64
60#define LINFO_LINESIZE 64
61#define LINFO_NAMESIZE 512
62#define LINFO_HOSTSIZE 256
63
64struct logininfo {
65	char       progname[LINFO_PROGSIZE];     /* name of program (for PAM) */
66	int        progname_null;
67	short int  type;                         /* type of login (LTYPE_*) */
68	pid_t      pid;                          /* PID of login process */
69	uid_t      uid;                          /* UID of this user */
70	char       line[LINFO_LINESIZE];         /* tty/pty name */
71	char       username[LINFO_NAMESIZE];     /* login username */
72	char       hostname[LINFO_HOSTSIZE];     /* remote hostname */
73	/* 'exit_status' structure components */
74	int        exit;                        /* process exit status */
75	int        termination;                 /* process termination status */
76	/* struct timeval (sys/time.h) isn't always available, if it isn't we'll
77	 * use time_t's value as tv_sec and set tv_usec to 0
78	 */
79	unsigned int tv_sec;
80	unsigned int tv_usec;
81	union login_netinfo hostaddr;       /* caller's host address(es) */
82}; /* struct logininfo */
83
84/*
85 * login recording functions
86 */
87
88/** 'public' functions */
89
90/* construct a new login entry */
91struct logininfo *login_alloc_entry(pid_t pid, const char *username,
92				    const char *hostname, const char *line);
93/* free a structure */
94void login_free_entry(struct logininfo *li);
95/* fill out a pre-allocated structure with useful information */
96int login_init_entry(struct logininfo *li, pid_t pid, const char *username,
97    const char *hostname, const char *line);
98/* place the current time in a logininfo struct */
99void login_set_current_time(struct logininfo *li);
100
101/* record the entry */
102int login_login (struct logininfo *li);
103int login_logout(struct logininfo *li);
104#ifdef LOGIN_NEEDS_UTMPX
105int login_utmp_only(struct logininfo *li);
106#endif
107
108/** End of public functions */
109
110/* record the entry */
111int login_write (struct logininfo *li);
112int login_log_entry(struct logininfo *li);
113
114/* set the network address based on network address type */
115void login_set_addr(struct logininfo *li, const struct sockaddr *sa,
116		    const unsigned int sa_size);
117
118/*
119 * lastlog retrieval functions
120 */
121/* lastlog *entry* functions fill out a logininfo */
122struct logininfo *login_get_lastlog(struct logininfo *li, const uid_t uid);
123/* lastlog *time* functions return time_t equivalent (uint) */
124unsigned int login_get_lastlog_time(const uid_t uid);
125
126/* produce various forms of the line filename */
127char *line_fullname(char *dst, const char *src, u_int dstsize);
128char *line_stripname(char *dst, const char *src, int dstsize);
129char *line_abbrevname(char *dst, const char *src, int dstsize);
130
131void record_failed_login(struct ssh *, const char *, const char *,
132    const char *);
133
134#endif /* _HAVE_LOGINREC_H_ */
135