.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FS_GETCRYPT 1"
.TH FS_GETCRYPT 1 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fs_getcrypt \- Displays the state of encryption for AFS file transfers
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBfs getcrypt\fR [\fB\-help\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBfs getcrypt\fR command shows the status of network traffic encryption
for file traffic in the AFS client. This encryption applies to file
traffic going to and coming from the AFS server for users with valid
tokens. The complement of this command is \fBfs setcrypt\fR which sets the
status of encryption on the client.
.SH CAUTIONS
.IX Header "CAUTIONS"
AFS uses an encryption scheme called fcrypt, based on but slightly weaker
than DES. Because fcrypt and DES are obsolete, the user must decide how
much to trust the encryption. Consider using a Virtual Private Network at
the IP level if better encryption is needed.
.PP
Encrypting file traffic requires a token. Unauthenticated connections or
connections authorized via IP-based ACLs will not be encrypted even when
encryption is turned on.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH OUTPUT
.IX Header "OUTPUT"
If encryption is enabled, the output is:
.PP
.Vb 1
\&   Security level is currently crypt (data security).
.Ve
.PP
If encryption if disabled, the output is:
.PP
.Vb 1
\&   Security level is currently clear.
.Ve
.SH EXAMPLES
.IX Header "EXAMPLES"
There is only one way to invoke \fBfs getcrypt\fR:
.PP
.Vb 1
\&   % fs getcrypt
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
No special privileges are required for this command.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBfs_setcrypt\fR\|(1)
.PP
The description of the fcrypt encryption mechanism at
<http://surfvi.com/~ota/fcrypt\-paper.txt>.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
.PP
This documentation is covered by the BSD License as written in the
doc/LICENSE file. This man page was written by Jason Edgecombe for
OpenAFS.