Install samlsign in opensaml2-tools
authorRuss Allbery <rra@debian.org>
Tue, 17 Jun 2008 01:12:49 +0000 (18:12 -0700)
committerRuss Allbery <rra@debian.org>
Tue, 17 Jun 2008 01:12:49 +0000 (18:12 -0700)
Move the samlsign binary from libsaml2 to opensaml2-tools.  Per Policy
8.2, shared library packages can't contain user binaries since then
the libraries will conflict with each other after an SONAME change.

Add a man page for samlsign based on an initial version written by
Ferenc Wágner.

debian/control
debian/libsaml2.install
debian/opensaml2-tools.install [new file with mode: 0644]
debian/samlsign.1 [new file with mode: 0644]

index 5822224..a266be7 100644 (file)
@@ -36,6 +36,18 @@ Description: Open source SAML library (development)
  This package contains the headers and other necessary files to build
  applications or libraries that use or extend the OpenSAML library.
 
+Package: opensaml2-tools
+Section: text
+Architecture: any
+Depends: ${shibs:Depends}
+Description: Security Assertion Markup Language command-line tools
+ OpenSAML is an open source implementation of the OASIS Security Assertion
+ Markup Language Specification. It contains a set of open source C++ classes
+ that support the SAML 1.0, 1.1, and 2.0 specifications.
+ .
+ This package contains samlsign, a command-line tool for signing and
+ verifying SAML assertions. 
+
 Package: opensaml2-schemas
 Section: text
 Architecture: all
index 72835f7..c45ebcf 100644 (file)
@@ -1,2 +1 @@
 debian/tmp/usr/lib/lib*.so.*
-debian/tmp/usr/bin/*
diff --git a/debian/opensaml2-tools.install b/debian/opensaml2-tools.install
new file mode 100644 (file)
index 0000000..8ffdce8
--- /dev/null
@@ -0,0 +1 @@
+debian/tmp/usr/bin/*
diff --git a/debian/samlsign.1 b/debian/samlsign.1
new file mode 100644 (file)
index 0000000..63d2133
--- /dev/null
@@ -0,0 +1,146 @@
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.TH SAMLSIGN 1 "2008 Jun 16" Internet2 "OpenSAML manual"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+samlsign \- sign and verify XML documents
+.SH SYNOPSIS
+.B samlsign
+.RI < options >
+.SH DESCRIPTION
+.B samlsign
+signs or verifies signed XML documents.
+To sign a document, use
+.BR -s .
+To verify a document, omit
+.BR -s .
+One of the
+.BR -c ,
+.BR -R ,
+or
+.B -T
+options are required when verifying.
+Either
+.B -k
+or
+.B -R
+is required when signing.
+.PP
+By default,
+.B samlsign
+signs or verifies standard input.  Pass
+.B -u
+or
+.B -f
+to retrieve the document from a URL or file path.
+Signed documents are always printed to standard output.
+.SH OPTIONS
+.TP
+.BI \-u " URL"
+The URL of the document to sign or verify.
+.TP
+.BI \-f " PATH"
+The full path of the document to sign or verify.
+.TP
+.BI \-id " ID"
+Rather than acting on the entire document, only act on the object with the
+specified
+.IR ID .
+Only that object (with its new signature) will be printed to standard
+output.
+.TP
+.B \-s
+Sign, rather than the default action of verify.
+.TP
+.BI \-k " KEY"
+Specifies the full path to the key to use for signing.
+.TP
+.BI \-c " CERT"
+Specifies the full path to the certificate to use for verification.
+.TP
+.BI \-R " RESOLVER"
+Specifies a credential resolver to use for either signing or verification.
+.TP
+.BI \-T " TRUST"
+Specifies the trust engine for TrustEngine-based verification.
+.TP 
+.BI \-M " METADATA"
+Specifies the metadata for TrustEngine-based verification.
+.TP
+.BI \-i " ISSUER"
+Specifies the issuer for verification.
+.TP
+.BI \-p " PROT"
+Specifies the protocol for TrustEngine-based verification.
+This option allows specification of an arbitrary protocol by name, but
+more commonly one would use one of the options listed below for standard
+protocol names.
+.TP
+.BI \-r " RNAME"
+Specifies the resource name for TrustEngine-based verification.
+This option allows specification of an arbitrary resource name by name,
+but more commonly one would use one of the options listed below for
+standard resource names.
+.TP
+.BI \-ns " RNS"
+Specifies the namespace for TrustEngine-based verification.  If not given,
+the default is SAML20MD_NS.
+.TP
+.B \-saml10
+Use the SAML1.0 protocol for TrustEngine-based verification.
+.TP
+.B \-saml11
+use the SAML1.1 protocol for TrustEngine-based verification.
+.TP
+.B \-saml2
+use the SAML2.0 P NS protocol for TrustEngine-based verification.
+.TP
+.B \-idp
+Set the resouce name to IDPSSODescriptor for TrustEngine-based
+verification.
+.TP
+.B \-aa
+Set the resource name to AttributeAuthorityDescriptor for
+TrustEngine-based verification.
+.TP
+.B \-pdp
+Set the resource name to PDPDescriptor for TrustEngine-based
+verification.
+.TP
+.B \-sp
+Set the resource name to SPSSODescriptor for TrustEngine-based
+verification.
+.SH "EXIT STATUS"
+.TP
+0
+Success.
+.TP
+\-1
+An error in how
+.B samlsign
+was called (incorrect arguments, for example).
+.TP
+\-2
+An error occurred when initializing the configuration.
+.TP
+\-10
+An exception was caught.
+.SH EXAMPLES
+To sign SAML 2.0 metadata, use:
+.PP
+.Vb 1
+\&    samlsign -k /path/to/key -c /path/to/cert -f /path/to/metadata
+.Ve
+.SH AUTHOR
+This manpage were written by Ferenc Wágner and Russ Allbery for Debian
+GNU/Linux.
+.SH COPYRIGHT
+Copyleft (C) 2008 Ferenc Wágner
+.br
+This is free software in the public domain.