usr/src/man/man1m/wanbootutil.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 WANBOOTUTIL 1M "Apr 18, 2003"
   7 .SH NAME
   8 wanbootutil \- manage keys and certificates for WAN booting
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBwanbootutil\fR [keygen] [\fIoption_specific_arguments\fR]
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBwanbootutil\fR [keymgmt] [\fIoption_specific_arguments\fR]
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBwanbootutil\fR [p12split] [\fIoption_specific_arguments\fR]
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBwanbootutil\fR command creates and manages WANboot encyrption and
  29 hashing keys and manipulates PKCS #12 files for use by WAN boot.
  30 .sp
  31 .LP
  32 \fBwanbootutil\fR has three subcommands, each covered in a separate man page:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBwanboot_keygen\fR(1M)\fR
  37 .ad
  38 .RS 24n
  39 Generates encryption and hashing keys.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBwanboot_keymgmt\fR(1M)\fR
  46 .ad
  47 .RS 24n
  48 Inserts and extracts keys from WAN boot key repositories.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBwanboot_p12split\fR(1M)\fR
  55 .ad
  56 .RS 24n
  57 Splits a PKCS #12 file into separate certificate and key files for use by WAN
  58 boot.
  59 .RE
  60
  61 .SH OPTIONS
  62 .sp
  63 .LP
  64 The options are supported for \fBwanbootutil\fR are the use of \fBkeygen\fR,
  65 \fBkeymgmt\fR, or \fBp12split\fR. The options for these subcommands are
  66 described in their respective man pages.
  67 .SH EXAMPLES
  68 .LP
  69 \fBExample 1 \fRGenerate a 3DES Client Key
  70 .sp
  71 .in +2
  72 .nf
  73 # wanbootutil keygen -c -o net=172.16.174.0,cid=010003BA0E6A36,type=3des
  74 .fi
  75 .in -2
  76 .sp
  77
  78 .LP
  79 \fBExample 2 \fRInsert an RSA Private Client Key
  80 .sp
  81 .in +2
  82 .nf
  83 wanbootutil keymgmt -i -k keyfile \e
  84   -s /etc/netboot/172.16.174.0/010003BA0E6A36/keystore -o type=rsa
  85 .fi
  86 .in -2
  87 .sp
  88
  89 .LP
  90 \fBExample 3 \fRSplit a PKCS #12 File into Certificate and Key Components
  91 .sp
  92 .in +2
  93 .nf
  94 # wanbootutil p12split -i p12file -c out_cert -k out_key
  95 .fi
  96 .in -2
  97 .sp
  98
  99 .SH EXIT STATUS
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fB0\fR\fR
 104 .ad
 105 .RS 12n
 106 Successful operation.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBnon-zero\fR\fR
 113 .ad
 114 .RS 12n
 115 An error occurred. Writes an appropriate error message to standard error.
 116 .RE
 117
 118 .SH ATTRIBUTES
 119 .sp
 120 .LP
 121 See \fBattributes\fR(5) for descriptions of the following attributes:
 122 .sp
 123
 124 .sp
 125 .TS
 126 box;
 127 c | c
 128 l | l .
 129 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 130 _
 131 Interface Stability     Obsolete
 132 .TE
 133
 134 .SH SEE ALSO
 135 .sp
 136 .LP
 137 \fBwanboot_keygen\fR(1M), \fBwanboot_keymgmt\fR(1M),
 138 \fBwanboot_p12split\fR(1M), \fBattributes\fR(5)