File: libnuclient.3

package info (click to toggle)
nufw 2.4.3-3.1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 5,784 kB
  • ctags: 4,292
  • sloc: ansic: 32,174; sh: 10,146; python: 4,176; perl: 630; makefile: 610; lex: 176; php: 168; yacc: 117; xml: 34
file content (55 lines) | stat: -rw-r--r-- 2,213 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "LIBNUCLIENT" "3" "12 mars 2007" "" ""

.SH NAME
libnuclient \- NUFW client authentication library
.SH SYNOPSIS
.sp
\fB#include <nuclient.h>
.sp
NuAuth * nu_client_init (const char *\fInptr\fB,  char *\fIusername\fB,  unsigned long\fI userid\fB,  char *\fI password\fB,  char *\fI hostname\fB,  unsigned int\fI port\fB,  char\fI protocol\fB,  char\fI ssl_on\fB);
.sp
int nu_client_check (NuAuth *\fI session\fB);
.sp
void nu_client_free (NuAuth *\fIsession\fB);
\fR
.SH "DESCRIPTION"
.PP
This manual page documents the
\fBlibnuclient\fR library.
.PP
Use \fBnu_client_init\fR to initialize a authentication session. Then call \fBnu_client_check\fR at 
regular interval to send authentication packet to the gateway (if needed). When you're finished, call \fBnu_client_free\fR
to free the session.
.PP
Original packaging and informations and help can be found from http://www.nufw.org/
.SH "RETURN VALUE"
.PP
\fBnu_client_init\fR returns an authentication session usable by \fBnu_client_check\fR or \fBnu_client_free\fR\&.
.PP
\fBnu_client_check\fR returns the number of packets authenticated to the nuauth server during the call. It returns -1 if
an error occur when sending authentication packet. Applications MUST considered that the session is unusable when they receive this error.
.SH "ERRORS"
.PP
\fBnu_client_init\fR return NULL it a problem occur during initiation
.SH "SEE ALSO"
.PP
nuauth(8)
.SH "AUTHOR"
.PP
Nufw was designed and coded by Eric Leblond, aka Regit (<regit@inl.fr>) , and Vincent
Deffontaines, aka gryzor (<vincent@inl.fr>). Original idea in 2001, while working on NSM Ldap
support.
.PP
This manual page was written by Eric Leblond
.PP
Permission is
granted to copy, distribute and/or modify this document under
the terms of the GNU Free Documentation
License, Version 2 as published by the Free
Software Foundation; with no Invariant Sections, no Front-Cover
Texts and no Back-Cover Texts.