Document lots of new features and syntax.
[fwd] / ident.h
1 /* -*-c-*-
2 *
3 * $Id: ident.h,v 1.2 1999/07/26 23:26:44 mdw Exp $
4 *
5 * Parse replies from RFC931 servers
6 *
7 * (c) 1999 Straylight/Edgeware
8 */
9
10 /*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of the `fw' port forwarder.
13 *
14 * `fw' is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
18 *
19 * `fw' is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with `fw'; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 */
28
29 /*----- Revision history --------------------------------------------------*
30 *
31 * $Log: ident.h,v $
32 * Revision 1.2 1999/07/26 23:26:44 mdw
33 * Change copyright notice.
34 *
35 * Revision 1.1.1.1 1999/07/01 08:56:23 mdw
36 * Initial revision.
37 *
38 * Revision 1.1.1.1 1999/05/21 22:22:27 mdw
39 * Initial import. Code not really finished yet.
40 *
41 */
42
43 #ifndef IDENT_H
44 #define IDENT_H
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 /*----- Data structures ---------------------------------------------------*/
51
52 typedef struct ident {
53 unsigned short sport, dport; /* Source and destination ports */
54 unsigned type; /* Type of reply from server */
55 union {
56 struct {
57 char *os; /* Operating system name */
58 char *user; /* User name */
59 } userid;
60 char *error; /* Error message from server */
61 } u;
62 } ident;
63
64 enum {
65 ident_userid,
66 ident_error,
67 ident_bad
68 };
69
70 /*----- Functions provided ------------------------------------------------*/
71
72 /* --- @ident_parse@ --- *
73 *
74 * Arguments: @char *p@ = pointer to input string from identd
75 * @ident *i@ = pointer to output block
76 *
77 * Returns: ---
78 *
79 * Use: Parses a result string from an RFC931 (identd) server.
80 */
81
82 extern void ident_parse(char */*p*/, ident */*i*/);
83
84 /*----- That's all, folks -------------------------------------------------*/
85
86 #ifdef __cplusplus
87 }
88 #endif
89
90 #endif