usr/src/man/man1m/wanboot_keygen.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 WANBOOT_KEYGEN 1M "Apr 18, 2003"
   7 .SH NAME
   8 wanboot_keygen \- create and display client and server keys for WAN booting
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/inet/wanboot/keygen\fR \fB-c\fR \fB-o\fR net=\fIa.b.c.d\fR ,cid=\fIclient_ID\fR,type=3des
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/lib/inet/wanboot/keygen\fR \fB-c\fR \fB-o\fR net=\fIa.b.c.d\fR ,cid=\fIclient_ID\fR,type=aes
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB/usr/lib/inet/wanboot/keygen\fR \fB-m\fR
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fB/usr/lib/inet/wanboot/keygen\fR \fB-c\fR \fB-o\fR net=\fIa.b.c.d\fR ,cid=\fIclient_ID\fR,type=sha1
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fB/usr/lib/inet/wanboot/keygen\fR \fB-d\fR \fB-m\fR
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fB/usr/lib/inet/wanboot/keygen\fR \fB-c\fR \fB-o\fR net=\fIa.b.c.d\fR ,cid=\fIclient_ID\fR,type=\fIkeytype\fR
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBkeygen\fR utility has three purposes:
  44 .RS +4
  45 .TP
  46 .ie t \(bu
  47 .el o
  48 Using the \fB-c\fR flag, to generate and store per-client 3DES/AES encryption
  49 keys, avoiding any DES weak keys.
  50 .RE
  51 .RS +4
  52 .TP
  53 .ie t \(bu
  54 .el o
  55 Using the \fB-m\fR flag, to generate and store a "master" HMAC SHA-1 key for
  56 WAN install, and to derive from the master key per-client HMAC SHA-1 hashing
  57 keys, in a manner described in RFC 3118, Appendix A.
  58 .RE
  59 .RS +4
  60 .TP
  61 .ie t \(bu
  62 .el o
  63 Using the \fB-d\fR flag along with either the \fB-c\fR or \fB-m\fR flag to
  64 indicate the key repository, to display a key of type specified by
  65 \fIkeytype\fR, which must be one of \fB3des\fR, \fBaes\fR, or \fBsha1\fR.
  66 .RE
  67 .sp
  68 .LP
  69 The \fBnet\fR and \fBcid\fR arguments are used to identify a specific client.
  70 Both arguments are optional. If the \fBcid\fR option is not provided, the key
  71 being created or displayed will have a per-network scope. If the \fBnet\fR
  72 option is not provided, then the key will have a global scope. Default net and
  73 code values are used to derive an HMAC SHA-1 key if the values are not provided
  74 by the user.
  75 .SH OPTIONS
  76 .sp
  77 .LP
  78 The following options are supported:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB-c\fR\fR
  83 .ad
  84 .RS 6n
  85 Generate and store per-client 3DES/AES encryption keys, avoiding any DES weak
  86 keys. Also generates and stores per-client HMAC SHA-1 keys. Used in conjunction
  87 with \fB-o\fR.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB-d\fR\fR
  94 .ad
  95 .RS 6n
  96 Display a key of type specified by \fIkeytype\fR, which must be one of
  97 \fB3des\fR, \fBaes\fR, or \fBsha1\fR. Use \fB-d\fR with \fB-m\fR or with
  98 \fB-c\fR and \fB-o\fR.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-m\fR\fR
 105 .ad
 106 .RS 6n
 107 Generate and store a "master" HMAC SHA-1 key for WAN install.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fB-o\fR\fR
 114 .ad
 115 .RS 6n
 116 Specifies the WANboot client and/or keytype.
 117 .RE
 118
 119 .SH EXAMPLES
 120 .LP
 121 \fBExample 1 \fRGenerate a Master HMAC SHA-1 Key
 122 .sp
 123 .in +2
 124 .nf
 125 # keygen -m
 126 .fi
 127 .in -2
 128 .sp
 129
 130 .LP
 131 \fBExample 2 \fRGenerate and Then Display a Client-Specific Master HMAC SHA-1
 132 Key
 133 .sp
 134 .in +2
 135 .nf
 136 # keygen -c -o net=172.16.174.0,cid=010003BA0E6A36,type=sha1
 137 # keygen -d -c -o net=172.16.174.0,cid=010003BA0E6A36,type=sha1
 138 .fi
 139 .in -2
 140 .sp
 141
 142 .LP
 143 \fBExample 3 \fRGenerate and Display a 3DES Key with a Per-Network Scope
 144 .sp
 145 .in +2
 146 .nf
 147 # keygen -c -o net=172.16.174.0,type=3des
 148 # keygen -d -o net=172.16.174.0,type=3des
 149 .fi
 150 .in -2
 151 .sp
 152
 153 .SH EXIT STATUS
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB0\fR\fR
 158 .ad
 159 .RS 6n
 160 Successful operation.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB>0\fR\fR
 167 .ad
 168 .RS 6n
 169 An error occurred.
 170 .RE
 171
 172 .SH ATTRIBUTES
 173 .sp
 174 .LP
 175 See \fBattributes\fR(5) for descriptions of the following attributes:
 176 .sp
 177
 178 .sp
 179 .TS
 180 box;
 181 c | c
 182 l | l .
 183 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 184 _
 185 Interface Stability     Obsolete
 186 .TE
 187
 188 .SH SEE ALSO
 189 .sp
 190 .LP
 191 \fBattributes\fR(5)