usr/src/man/man1m/ickey.1m

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ICKEY 1M "May 7, 2003"
   7 .SH NAME
   8 ickey \- install a client key for WAN boot
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/inet/wanboot/ickey\fR [\fB-d\fR] [\fB-o\fR type=3des]
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/lib/inet/wanboot/ickey\fR [\fB-d\fR] [\fB-o\fR type=aes]
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB/usr/lib/inet/wanboot/ickey\fR [\fB-d\fR] [\fB-o\fR type=sha1]
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBickey\fR command is used to install WAN boot keys on a running UNIX
  29 system so that they can be used the next time the system is installed. You can
  30 store three different types of keys: 3DES and AES for encryption and an HMAC
  31 SHA-1 key for hashed verification.
  32 .sp
  33 .LP
  34 \fBickey\fR reads the key from standard input using \fBgetpassphrase\fR(3C) so
  35 that it does not appear on the command line. When installing keys on a remote
  36 system, you must take proper precautions to ensure that any keying materials
  37 are kept confidential. At a minimum, use \fBssh\fR(1) to prevent interception
  38 of data in transit.
  39 .sp
  40 .LP
  41 Keys are expected to be presented as strings of hexadecimal digits; they can
  42 (but need not) be preceeded by a \fB0x\fR or \fB0X\fR.
  43 .sp
  44 .LP
  45 The \fBickey\fR command has a single option, described below. An argument of
  46 the type \fB-o\fR\ \fBtype=\fR\fIkeytype\fR is required.
  47 .SH OPTIONS
  48 .sp
  49 .LP
  50 The \fBickey\fR command the following option.
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-d\fR\fR
  55 .ad
  56 .RS 6n
  57 Delete the key specified by the \fIkeytype\fR argument.
  58 .RE
  59
  60 .SH EXIT STATUS
  61 .sp
  62 .LP
  63 On success, \fBickey\fR exits with status 0; if a problem occurs, a diagnostic
  64 message is printed and \fBickey\fR exits with non-zero status.
  65 .SH FILES
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB/dev/openprom\fR\fR
  70 .ad
  71 .RS 17n
  72 WAN boot key storage driver
  73 .RE
  74
  75 .SH ATTRIBUTES
  76 .sp
  77 .LP
  78 See \fBattributes\fR(5) for descriptions of the following attributes:
  79 .sp
  80
  81 .sp
  82 .TS
  83 box;
  84 c | c
  85 l | l .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 _
  88 Interface Stability     Unstable
  89 .TE
  90
  91 .SH SEE ALSO
  92 .sp
  93 .LP
  94 \fBssh\fR(1), \fBopenprom\fR(7D),  \fBattributes\fR(5)