debian/samlsign.1

   1 .de Vb \" Begin verbatim text
   2 .ft CW
   3 .nf
   4 .ne \\$1
   5 ..
   6 .de Ve \" End verbatim text
   7 .ft R
   8 .fi
   9 ..
  10 .TH SAMLSIGN 1 "2008 Jun 16" Internet2 "OpenSAML manual"
  11 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  12 .\" way too many mistakes in technical documents.
  13 .if n .ad l
  14 .nh
  15 .SH NAME
  16 samlsign \- sign and verify XML documents
  17 .SH SYNOPSIS
  18 .B samlsign
  19 .RI < options >
  20 .SH DESCRIPTION
  21 .B samlsign
  22 signs or verifies signed XML documents.
  23 To sign a document, use
  24 .BR \-s .
  25 To verify a document, omit
  26 .BR \-s .
  27 One of the
  28 .BR \-c ,
  29 .BR \-R ,
  30 or
  31 .B \-T
  32 options are required when verifying.
  33 Either
  34 .B \-k
  35 or
  36 .B \-R
  37 is required when signing.
  38 .PP
  39 By default,
  40 .B samlsign
  41 signs or verifies standard input.  Pass
  42 .B \-u
  43 or
  44 .B \-f
  45 to retrieve the document from a URL or file path.
  46 Signed documents are always printed to standard output.
  47 .SH OPTIONS
  48 .TP
  49 .BI \-u " URL"
  50 The URL of the document to sign or verify.
  51 .TP
  52 .BI \-f " PATH"
  53 The full path of the document to sign or verify.
  54 .TP
  55 .BI \-id " ID"
  56 Rather than acting on the entire document, only act on the object with the
  57 specified
  58 .IR ID .
  59 Only that object (with its new signature) will be printed to standard
  60 output.
  61 .TP
  62 .B \-s
  63 Sign, rather than the default action of verify.
  64 .TP
  65 .BI \-k " KEY"
  66 Specifies the full path to the key to use for signing.
  67 .TP
  68 .BI \-c " CERT"
  69 Specifies the full path to the certificate to use for verification.
  70 .TP
  71 .BI \-R " RESOLVER"
  72 Specifies a credential resolver to use for either signing or verification.
  73 .TP
  74 .BI \-T " TRUST"
  75 Specifies the trust engine for TrustEngine-based verification.
  76 .TP
  77 .BI \-M " METADATA"
  78 Specifies the metadata for TrustEngine-based verification.
  79 .TP
  80 .BI \-i " ISSUER"
  81 Specifies the issuer for verification.
  82 .TP
  83 .BI \-p " PROT"
  84 Specifies the protocol for TrustEngine-based verification.
  85 This option allows specification of an arbitrary protocol by name, but
  86 more commonly one would use one of the options listed below for standard
  87 protocol names.
  88 .TP
  89 .BI \-r " RNAME"
  90 Specifies the resource name for TrustEngine-based verification.
  91 This option allows specification of an arbitrary resource name by name,
  92 but more commonly one would use one of the options listed below for
  93 standard resource names.
  94 .TP
  95 .BI \-ns " RNS"
  96 Specifies the namespace for TrustEngine-based verification.  If not given,
  97 the default is SAML20MD_NS.
  98 .TP
  99 .B \-saml10
 100 Use the SAML1.0 protocol for TrustEngine-based verification.
 101 .TP
 102 .B \-saml11
 103 use the SAML1.1 protocol for TrustEngine-based verification.
 104 .TP
 105 .B \-saml2
 106 use the SAML2.0 P NS protocol for TrustEngine-based verification.
 107 .TP
 108 .B \-idp
 109 Set the resouce name to IDPSSODescriptor for TrustEngine-based
 110 verification.
 111 .TP
 112 .B \-aa
 113 Set the resource name to AttributeAuthorityDescriptor for
 114 TrustEngine-based verification.
 115 .TP
 116 .B \-pdp
 117 Set the resource name to PDPDescriptor for TrustEngine-based
 118 verification.
 119 .TP
 120 .B \-sp
 121 Set the resource name to SPSSODescriptor for TrustEngine-based
 122 verification.
 123 .SH "EXIT STATUS"
 124 .TP
 125 0
 126 Success.
 127 .TP
 128 \-1
 129 An error in how
 130 .B samlsign
 131 was called (incorrect arguments, for example).
 132 .TP
 133 \-2
 134 An error occurred when initializing the configuration.
 135 .TP
 136 \-10
 137 An exception was caught.
 138 .SH EXAMPLES
 139 To sign SAML 2.0 metadata, use:
 140 .PP
 141 .Vb 1
 142 \&    samlsign \-k /path/to/key \-c /path/to/cert \-f /path/to/metadata
 143 .Ve
 144 .SH AUTHOR
 145 This manpage were written by Ferenc Wágner and Russ Allbery for Debian
 146 GNU/Linux.
 147 .SH COPYRIGHT
 148 Copyleft (C) 2008 Ferenc Wágner
 149 .br
 150 This is free software in the public domain.