.\" 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 "NUTCPC" "1" "14 November 2008" "" ""

.SH NAME
nutcpc \- NuFW console-mode client for GNU/Linux and BSD systems
.SH SYNOPSIS

\fBnutcpc\fR [ \fB-d \fR ] [ \fB-l \fR ] [ \fB-k \fR ] [ \fB-c \fR ] [ \fB-V \fR ] [ \fB-h \fR ] [ \fB-q \fR ] [ \fB-Q \fR ] [ \fB-N \fR ] [ \fB-H \fINuauth IP\fB\fR ] [ \fB-p \fINuauth port \fB\fR ] [ \fB-U \fIUserID\fB\fR ] [ \fB-P \fIUserPassword\fB\fR ] [ \fB-I \fIInterval\fB\fR ] [ \fB-Z \fIService\fB\fR ] [ \fB-C \fICertFile\fB\fR ] [ \fB-A \fIAuthorityFile\fB\fR ] [ \fB-K \fIKeyFile\fB\fR ] [ \fB-W \fICertPass\fB\fR ] [ \fB-R \fICrlFile\fB\fR ] [ \fB-a \fINuauthDN\fB\fR ]

.SH "DESCRIPTION"
.PP
This manual page documents the
\fBnutcpc\fR command.
.PP
nutcpc is a console-mode client for the NuFW authenticating firewall. It sends
authentication packets to the nuauth server. All parameters can be set on commandline but nutcpc can also be configured via the file nuclient.conf(5).
.PP
Original packaging and informations and help can be found from http://www.nufw.org/
.SH "OPTIONS"
.TP
\fB-d \fR
Debug mode, don't go into background.
.TP
\fB-l \fR
Do not verify whether lock file exists before starting. And do
not create lock file.
.TP
\fB-k \fR
Kill existing instances of the program running
on our local userID.
.TP
\fB-c \fR
Check if a client is already running. Return error if no client are running.
.TP
\fB-V \fR
Issues program version and exits.
.TP
\fB-h \fR
Issues usage details and exits.
.TP
\fB-q \fR
Do not display running nutcpc options on "ps". Useful when using "-W"
.TP
\fB-H \fINuauth IP\fB \fR
Send authentication packet  to \fINuauth IP\fR\&.
.TP
\fB-p \fINuauth port\fB \fR
Send authentication packet  to \fINuauth port\fR\&.
.TP
\fB-U \fIUser ID\fB \fR
Set nufw userid to \fIUser ID\fR\&.
.TP
\fB-P \fIUser Password\fB \fR
Set nufw password to \fIUser Password\fR\&.
.TP
\fB-I \fIInterval\fB \fR
Set connection list refresh interval to \fIInterval\fR\&. This option is only useful if nuauth server is in POLL mode.
.TP
\fB-Z \fIService\fB \fR
Set kerberos service name to \fIService\fR\&.
.TP
\fB-C \fICertFile\fB \fR
Use certificate file stored in the file \fICertFile\fR to negotiate the TLS connection to nuauth.
.TP
\fB-A \fIAuthorityFile\fB \fR
Use authority file stored in \fIAuthorityFile\fR and check the validity of nuauth certificate against this authority.  Nutcpc will leave if this is not the case.
.TP
\fB-K \fIKeyFile\fB \fR
Use key file stored in the file \fIKeyFile\fR to negotiate the TLS connection to nuauth.
.TP
\fB-W \fICertPass\fB \fR
Use the passphrase \fICertPass\fR to decrypt the certificate. Check the \fI-q\fR option if you use this.
.TP
\fB-R \fICrlFile\fB \fR
Use certificate revocation list file stored in the file \fICrlFile\fR to negotiate the TLS connection to nuauth. nutcpc reloads this file if it gets disconnected from nuauth and needs to reconnect. Since version 2.2.19, nutcpc reloads the CRL file when receiving a HUP signal.
.TP
\fB-a \fINuauthDN\fB \fR
Verify that the certificate given by nuauth has a DN equal to \fINuauthDN\fR\&. Nutcpc will leave if this is not the case.
.TP
\fB-Q \fR
Suppress warning if no certificate authority is configured.
.TP
\fB-N \fR
Suppress error if server FQDN does not match certificate CN.
.SH "LOCK FILE"
.PP
By default, the lock file set by nutcpc is at ~/.nufw/nutcpc.
.SH "CERTIFICATE AUTHENTICATION"
.PP
User authentication can be done using a certificate and a private key. Such a method will be used, if nutcpc can find a certificate at ~/.nufw/cert.pem and the corresponding private key at ~/.nufw/key.pem. The server identity will be checked if a CA certificate is provided in ~/.nufw/cacert.pem. Certificates and key can also be provided on command line or via nuclient.conf(5).
.SH "SIGNALS"
.TP
\fBHUP \fR
When receiving this signal, nutcpc attempts to immediately
reconnect to the server, if disconnected. The signal is ignored in
other cases.
.SH "SEE ALSO"
.PP
nufw(8)
.PP
nuauth(8)
.PP
nuclient.conf(5)
.SH "AUTHOR"
.PP
Nuauth was designed and coded by Eric Leblond, aka Regit (<eric@regit.org>) , and Vincent
Deffontaines, aka gryzor (<vincent@gryzor.com>). 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.