1 .\" Copyright (c) 2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd "control utility for shared secret devices"
61 utility is used for setting up a device which contains a shared secret.
62 The secret is shared between the given providers.
63 To collect the secret, all providers are needed.
64 If one of the components is missing, there is no way to get any useful data from
68 indicates an action to be performed:
69 .Bl -tag -width ".Cm destroy"
71 Set up a shared secret device from the given components with the specified
73 Metadata are stored in the last sector of every component.
75 Turn off an existing shared secret device by its
77 This command does not touch on-disk metadata!
79 Clear metadata on the given providers.
81 Dump metadata stored on the given providers.
97 .Bl -tag -width ".Fl f"
99 Force the removal of the specified shared secret device.
101 Hardcode providers' names in metadata.
106 Exit status is 0 on success, and 1 if the command fails.
108 The following example shows how to create a shared secret device.
109 The secret will be split between a slice on a local disk and a USB Pen drive.
110 .Bd -literal -offset indent
111 gshsec label -v secret /dev/ada0s1 /dev/da0
112 newfs /dev/shsec/secret
115 From now on, when the USB Pen drive is inserted, it will be automatically
116 detected and connected, making the secret available via the
117 .Pa /dev/shsec/secret
130 .An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org