summaryrefslogtreecommitdiff
path: root/docs/manpages/smbta-util.8
blob: 11eab1aae276486f9038608acfebc28635bbd3b2 (plain)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
'\" t
.\"     Title: smbta-util
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 02/21/2015
.\"    Manual: System Administration tools
.\"    Source: Samba 4.0
.\"  Language: English
.\"
.TH "SMBTA\-UTIL" "8" "02/21/2015" "Samba 4\&.0" "System Administration tools"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
smbta-util \- control encryption in VFS smb_traffic_analyzer
.SH "SYNOPSIS"
.HP \w'\ 'u
smbta\-util [\fICOMMANDS\fR...]
.SH "DESCRIPTION"
.PP
This tool is part of the
\fBsamba\fR(1)
suite\&.
.PP
smbta\-util
is a tool to ease the configuration of the vfs_smb_traffic_analyzer module regarding data encryption\&.
.PP
The user can generate a key, install a key (activating encryption), or uninstall a key (deactivating encryption)\&. Any operation that installs a key will create a File containing the key\&. This file can be used by smbta\-tool on other machines to install the same key from the file\&.
.SH "COMMANDS"
.PP
\fB\-h\fR
.RS 4
Show a short help text on the command line\&.
.RE
.PP
\fB\-f\fR \fIKEYFILE\fR
.RS 4
Open an existing keyfile, read the key from the file, and install the key, activating encryption\&.
.RE
.PP
\fB\-g\fR \fIKEYFILE\fR
.RS 4
Generate a new random key, install the key, activate encryption, and store the key into the file KEYFILE\&.
.RE
.PP
\fB\-u\fR
.RS 4
Uninstall the key, deactivating encryption\&.
.RE
.PP
\fB\-s\fR
.RS 4
Check if a key is installed\&.
.RE
.PP
\fB\-c\fR \fIKEYFILE\fR
.RS 4
Create a KEYFILE from an installed key\&.
.RE
.SH "VERSION"
.PP
This man page is correct for version 3\&.4 of the Samba suite\&.
.SH "AUTHOR"
.PP
The original version of smbta\-util was created by Holger Hetterich\&.
.PP
The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.