Print this page 
11622 clean up rarer mandoc lint warnings
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man1m/cryptoadm.1m
          +++ new/usr/src/man/man1m/cryptoadm.1m
   1    1  '\" te
   2    2  .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   3    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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4    4  .\" See the License for the specific language governing permissions and limitations under the License. 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
   5    5  .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6    6  .TH CRYPTOADM 1M "Sep 1, 2009"
   7    7  .SH NAME
   8    8  cryptoadm \- cryptographic framework administration
   9    9  .SH SYNOPSIS
  10      -.LP
  11   10  .nf
  12   11  \fBcryptoadm\fR list [\fB-mpv\fR] [provider=\fIprovider-name\fR]
  13   12       [mechanism=\fImechanism-list\fR]
  14   13  .fi
  15   14  
  16   15  .LP
  17   16  .nf
  18   17  \fBcryptoadm\fR disable
  19   18       provider=\fIprovider-name\fR mechanism=\fImechanism-list\fR | random | all
  20   19  .fi
↓ open down ↓ 54 lines elided ↑ open up ↑ 
  75   74  .nf
  76   75  \fBcryptoadm\fR stop
  77   76  .fi
  78   77  
  79   78  .LP
  80   79  .nf
  81   80  \fBcryptoadm\fR \fB-\fR\fB-help\fR
  82   81  .fi
  83   82  
  84   83  .SH DESCRIPTION
  85      -.sp
  86      -.LP
  87   84  The \fBcryptoadm\fR utility displays cryptographic provider information for a
  88   85  system, configures the mechanism policy for each provider, and installs or
  89   86  uninstalls a cryptographic provider. The cryptographic framework supports three
  90   87  types of providers: a user-level provider (a PKCS11 shared library), a kernel
  91   88  software provider (a loadable kernel software module), and a kernel hardware
  92   89  provider (a cryptographic hardware device).
  93   90  .sp
  94   91  .LP
  95   92  For kernel software providers, the \fBcryptoadm\fR utility provides the
  96   93  \fBunload\fR subcommand. This subcommand instructs the kernel to unload a
↓ open down ↓ 39 lines elided ↑ open up ↑ 
 136  133  .el o
 137  134  subcommand \fBlist\fR, any options
 138  135  .RE
 139  136  .RS +4
 140  137  .TP
 141  138  .ie t \(bu
 142  139  .el o
 143  140  subcommand \fB-\fR\fB-help\fR
 144  141  .RE
 145  142  .SH OPTIONS
 146      -.sp
 147      -.LP
 148  143  The \fBcryptoadm\fR utility has the various combinations of subcommands and
 149  144  options shown below.
 150  145  .sp
 151  146  .ne 2
 152  147  .na
 153  148  \fB\fBcryptoadm\fR \fBlist\fR\fR
 154  149  .ad
 155  150  .sp .6
 156  151  .RS 4n
 157  152  Display the list of installed providers.
↓ open down ↓ 278 lines elided ↑ open up ↑ 
 436  431  .ne 2
 437  432  .na
 438  433  \fB\fBcryptoadm\fR \fB-help\fR\fR
 439  434  .ad
 440  435  .sp .6
 441  436  .RS 4n
 442  437  Display the command usage.
 443  438  .RE
 444  439  
 445  440  .SH OPERANDS
 446      -.sp
 447  441  .ne 2
 448  442  .na
 449  443  \fBprovider=\fIprovider-name\fR\fR
 450  444  .ad
 451  445  .sp .6
 452  446  .RS 4n
 453  447  A user-level provider (a PKCS11 shared library), a kernel software provider (a
 454  448  loadable kernel software module), or a kernel hardware provider (a
 455  449  cryptographic hardware device).
 456  450  .sp
↓ open down ↓ 133 lines elided ↑ open up ↑ 
 590  584  .nf
 591  585  # \fBcryptoadm enable provider=des mechanism=all\fR
 592  586  .fi
 593  587  .in -2
 594  588  .sp
 595  589  
 596  590  \&...which enables all mechanisms on the provider, but enables no other
 597  591  provider-features, such as \fBrandom\fR.
 598  592  .RE
 599  593  .SH EXAMPLES
 600      -.LP
 601  594  \fBExample 1 \fRDisplay List of Providers Installed in System
 602  595  .sp
 603  596  .LP
 604  597  The following command displays a list of all installed providers:
 605  598  
 606  599  .sp
 607  600  .in +2
 608  601  .nf
 609  602  example% \fBcryptoadm list\fR
 610  603  user-level providers:
↓ open down ↓ 145 lines elided ↑ open up ↑ 
 756  749  
 757  750  .sp
 758  751  .in +2
 759  752  .nf
 760  753  example# \fBcryptoadm enable metaslot token="SUNW,venus"\fR
 761  754  .fi
 762  755  .in -2
 763  756  .sp
 764  757  
 765  758  .SH EXIT STATUS
 766      -.sp
 767      -.LP
 768  759  The following exit values are returned:
 769  760  .sp
 770  761  .ne 2
 771  762  .na
 772  763  \fB\fB0\fR\fR
 773  764  .ad
 774  765  .sp .6
 775  766  .RS 4n
 776  767  Successful completion.
 777  768  .RE
↓ open down ↓ 2 lines elided ↑ open up ↑ 
 780  771  .ne 2
 781  772  .na
 782  773  \fB\fB>0\fR\fR
 783  774  .ad
 784  775  .sp .6
 785  776  .RS 4n
 786  777  An error occurred.
 787  778  .RE
 788  779  
 789  780  .SH ATTRIBUTES
 790      -.sp
 791      -.LP
 792  781  See \fBattributes\fR(5) for descriptions of the following attributes:
 793  782  .sp
 794  783  
 795  784  .sp
 796  785  .TS
 797  786  box;
 798  787  c | c
 799  788  l | l .
 800  789  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 801  790  _
 802  791  Interface Stability     See below
 803  792  .TE
 804  793  
 805  794  .sp
 806  795  .LP
 807  796  The \fBstart\fR, \fBstop\fR, and \fBrefresh\fR options are Private interfaces.
 808  797  All other options are Evolving. The utility name is Stable.
 809  798  .SH SEE ALSO
 810      -.sp
 811      -.LP
 812  799  \fBlogadm\fR(1M), \fBsvcadm\fR(1M), \fBsyslogd\fR(1M), \fBlibpkcs11\fR(3LIB),
 813  800  \fBexec_attr\fR(4), \fBprof_attr\fR(4), \fBattributes\fR(5), \fBsmf\fR(5),
 814  801  \fBrandom\fR(7D)
 815      -.sp
 816      -.LP
 817  802  
 818  803  .sp
 819  804  .LP
 820  805  \fISolaris Security for Developer's Guide\fR
 821  806  .SH NOTES
 822      -.sp
 823      -.LP
 824  807  If a hardware provider's policy was made explicitly (that is, some of its
 825  808  mechanisms were disabled) and the hardware provider has been detached, the
 826  809  policy of this hardware provider is still listed.
 827  810  .sp
 828  811  .LP
 829  812  \fBcryptoadm\fR assumes that, minimally, a 32-bit shared object is delivered
 830  813  for each user-level provider. If both a 32-bit and 64-bit shared object are
 831  814  delivered, the two versions must provide the same functionality. The same
 832  815  mechanism policy applies to both.
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX