.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SHIB-METAGEN.1 1"
.TH SHIB-METAGEN.1 1 2024-02-03 3.4.1 Shibboleth
.\" 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
shib\-metagen \- Generate metadata for a Shibboleth SP
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBshib-metagen\fR [\fB\-12ADLNO\fR] [\fB\-c\fR \fIcert\fR [\fB\-c\fR \fIcert\fR ...]]
    [\fB\-e\fR \fIentity-id\fR] [\fB\-f\fR \fIformat\fR [\fB\-f\fR \fIformat\fR ...]]
    [\fB\-h\fR \fIhost\fR [\fB\-h\fR \fIhost\fR ...]] [\fB\-n\fR \fIhost\fR [\fB\-n\fR \fIhost\fR ...]]
    [\fB\-l\fR \fIhost-file\fR] [\fB\-o\fR \fIorganization\fR]
    [\fB\-a\fR \fIadmin\fR [\fB\-a\fR \fIadmin\fR ...]]
    [\fB\-s\fR \fIsupport\fR [\fB\-s\fR \fIsupport\fR ...]]
    [\fB\-t\fR \fItech\fR [\fB\-t\fR \fItech\fR ...]] [\fB\-u\fR \fIurl\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Generate metadata for a Shibboleth SP.  The metadata is printed to
standard output.  Most of the parameters are optional, but at least one of
\&\fB\-h\fR or \fB\-n\fR must be given to specify the hostname to use in
constructing URLs for the Shibboleth service for the SP.  Other metadata
can be added by using the other command-line parameters.  Most parameters
can be given multiple times.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-1\fR 4
.IX Item "-1"
Generate SAML 1.0 metadata.  The default, if neither \fB\-1\fR nor \fB\-2\fR is
given, is to generate metadata for both SAML 1.0 and SAML 2.0.
.IP \fB\-2\fR 4
.IX Item "-2"
Generate SAML 2.0 metadata.  The default, if neither \fB\-1\fR nor \fB\-2\fR is
given, is to generate metadata for both SAML 1.0 and SAML 2.0.
.IP \fB\-A\fR 4
.IX Item "-A"
Include artifact metadata.
.IP "\fB\-a\fR \fIadmin\fR" 4
.IX Item "-a admin"
An administrative contact for this Shibboleth SP.  This option may be
omitted, in which case administrative contact metadata is not included, or
may be given multiple times to list multiple contacts.  \fIadmin\fR should be
in the form \f(CW\*(C`\fR\f(CIfirst\fR\f(CW/\fR\f(CIlast\fR\f(CW/\fR\f(CIemail\fR\f(CW\*(C'\fR where \fIfirst\fR is the given name
and \fIlast\fR is the surname.
.IP "\fB\-c\fR \fIcert\fR" 4
.IX Item "-c cert"
Specifies the SSL certificate used to identify this Shibboleth SP.  This
option may be given multiple times to specify multiple certificates.  If
it is not given, the default certificate is \fIsp\-cert.pem\fR in the current
working directory.
.IP \fB\-D\fR 4
.IX Item "-D"
Include discovery service information in the metadata.  By default,
discovery service information is not included.
.IP "\fB\-e\fR \fIentity-id\fR" 4
.IX Item "-e entity-id"
The entity ID for this SP.  This must be a unique identifier for this SP
and must be a URL.  If \fB\-o\fR is given and \fB\-u\fR is not given, \fIentity-id\fR
is used as the URL for the organization running this Shibboleth SP.  If it
is not specified, it defaults to \f(CW\*(C`https://\fR\f(CIhost\fR\f(CW/shibboleth\*(C'\fR where
\&\fIhost\fR is the argument to the first \fB\-h\fR option.
.IP "\fB\-f\fR \fIformat\fR" 4
.IX Item "-f format"
Include this NameIDFormat in the metadata.  This option may be given more
than once.
.IP "\fB\-h\fR \fIhost\fR" 4
.IX Item "-h host"
A hostname for this SP (possibly a virtual host).  Either this option, the
\&\fB\-n\fR option, or the \fB\-l\fR option must be specified at least once.  It
should be repeated for every virtual host that responds to the Shibboleth
protocol.  \fB\-h\fR should be used for hostnames or virtual hosts that use
SSL.
.IP \fB\-L\fR 4
.IX Item "-L"
Include Single Logout information in the metadata.  This is not included
by default.
.IP "\fB\-l\fR \fIhost-list\fR" 4
.IX Item "-l host-list"
Read the list of hostnames for this SP from a file.  Each line of the file
will be treated as if it were passed as an argument to the \fB\-h\fR option to
specify a hostname or virtual host that responds to the Shibboleth
protocol and uses SSL.
.IP \fB\-N\fR 4
.IX Item "-N"
Include NameID management information in the metadata.  This is not
included by default.
.IP "\fB\-n\fR \fIhost\fR" 4
.IX Item "-n host"
A hostname for this SP (possibly a virtual host).  Either this option, the
\&\fB\-h\fR, or the \fB\-l\fR option must be specified at least once.  It should be
repeated for every virtual host that responds to the Shibboleth protocol.
\&\fB\-n\fR should be used for hostnames or virtual hosts that do not use SSL to
protect the Shibboleth communication.
.IP \fB\-O\fR 4
.IX Item "-O"
Include XML namespace declarations in the generated metadata.  This is the
default.
.IP "\fB\-o\fR \fIorganization\fR" 4
.IX Item "-o organization"
The name of the organization that runs this Shibboleth SP.  This option
may be given only once and may be omitted, in which case organization
metadata is not included.  This is normally not necessary but may be used
by other software systems for purposes such as displaying lists of
entities with human-readable names.
.IP "\fB\-s\fR \fIsupport\fR" 4
.IX Item "-s support"
A support contact for this Shibboleth SP.  This option may be omitted, in
which case support contact metadata is not included, or may be given
multiple times to list multiple contacts.  \fIsupport\fR should be in the
form \f(CW\*(C`\fR\f(CIfirst\fR\f(CW/\fR\f(CIlast\fR\f(CW/\fR\f(CIemail\fR\f(CW\*(C'\fR where \fIfirst\fR is the given name and
\&\fIlast\fR is the surname.
.IP "\fB\-t\fR \fItech\fR" 4
.IX Item "-t tech"
A technical contact for this Shibboleth SP.  This option may be omitted,
in which case technical contact metadata is not included, or may be given
multiple times to list multiple contacts.  \fItech\fR should be in the form
\&\f(CW\*(C`\fR\f(CIfirst\fR\f(CW/\fR\f(CIlast\fR\f(CW/\fR\f(CIemail\fR\f(CW\*(C'\fR where \fIfirst\fR is the given name and \fIlast\fR
is the surname.
.IP "\fB\-u\fR \fIurl\fR" 4
.IX Item "-u url"
Sets the URL for the organization.  This information is only used if the
\&\fB\-o\fR option is also given to specify the name of the organization.  If
\&\fB\-o\fR is given and \fB\-u\fR is not given, the entity ID (set with \fB\-e\fR) is
used as the organization URL.
.SH AUTHOR
.IX Header "AUTHOR"
This manual page was written by Russ Allbery for Debian GNU/Linux.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2009, 2011 Russ Allbery.  This manual page is hereby placed into
the public domain by its author.