man/ipsilon-client-install.1

   1 .\" Copyright (C) 2015 Ipsilon Project Contributors
   2 .\"
   3 .TH "ipsilon-client-install" "1" "1.0.0" "Ipsilon" "Ipsilon Manual Pages"
   4 .SH "NAME"
   5 ipsilon\-client\-install \- Configure an Ipsilon client
   6 .SH "SYNOPSIS"
   7 ipsilon\-client\-install [OPTION]...
   8 .SH "DESCRIPTION"
   9 Configures a server to be used as a Service Provider (SP) in federation with an Ipsilon instance as its Identity Provider (IdP).
  10
  11 By default, Apache is configured using mod_auth_mellon to handle the SAML 2 Federation.
  12 .SH "OPTIONS"
  13 \fB\-h\fR, \fB\-\-help\fR
  14 Show help message and exit
  15 .TP
  16 \fB\-\-version\fR
  17 Show program's version number and exit
  18 .TP
  19 \fB\-\-hostname\fR \fIHOSTNAME\fR
  20 Machine's fully qualified host name
  21 .TP
  22 \fB\-\-port\fR PORT
  23 Port number that SP listens on. The default is to not set a specific listen port. The \-\-saml\-secure\-setup option can affect this.
  24 .TP
  25 \fB\-\-admin\-user\fR \fIADMIN_USER\fR
  26 Account allowed to create a Service Provider (SP). The default is admin.
  27 .TP
  28 \fB\-\-admin\-password\fR \fIADMIN_PASSWORD\fR
  29 File containing the password for the account used toc reate a SP (\- to read from stdin)
  30 .TP
  31 \fB\-\-httpd\-user\fR \fIHTTPD_USER\fR
  32 Web server account used. Some files created by the installation will be chown(1) to this user. The default is apache.
  33 .TP
  34 \fB\-\-saml\fR
  35 Boolean value whether to install a saml2 SP or not. Default is True.
  36 .TP
  37 \fB\-\-saml\-idp\-url\fR \fISAML_IDP_URL\fR
  38 An URL of the Ipsilon instance to register the SP with.
  39 .TP
  40 \fB\-\-saml\-idp\-metadata\fR \fISAML_IDP_METADATA\fR
  41 An URL pointing at the IDP Metadata (FILE or HTTP)
  42 .TP
  43 \fB\-\-saml\-no\-httpd\fR
  44 Do not configure httpd. The default is False.
  45 .TP
  46 \fB\-\-saml\-base\fR \fISAML_BASE\fR
  47 Where saml2 authdata is available (default: /)
  48 .TP
  49 \fB\-\-saml\-auth\fR \fISAML_AUTH\fR
  50 Where saml2 authentication is enforced. The default is /saml2protected. This only applies when configuring Apache.
  51 .TP
  52 \fB\-\-saml\-sp\fR \fISAML_SP\fR
  53 Where saml communication happens. The default is /saml2.
  54 .TP
  55 \fB\-\-saml\-sp\-logout\fR \fISAML_SP_LOGOUT\fR
  56 Single Logout URL. The default is /saml2/logout.
  57 .TP
  58 \fB\-\-saml\-sp\-post\fR \fISAML_SP_POST\fR
  59 Post response URL. The default is /saml2/postResponse.
  60 .TP
  61 \fB\-\-saml\-secure\-setup\fR
  62 Turn on all security checks. The default is True.
  63 .TP
  64 \fB\-\-saml\-nameid\fR
  65 The saml2 NameID format that this SP will use. Must be one of: x509,transient,persistent,windows,encrypted,kerberos,email,unspecified,entity. The default is unspecified.
  66 .TP
  67 \fB\-\-saml\-sp\-name\fR \fISAML_SP_NAME\fR
  68 The SP name to register with the IdP.
  69 .TP
  70 \fB\-\-debug\fR
  71 Turn on script debugging
  72 .TP
  73 \fB\-\-uninstall\fR
  74 Uninstall the ipsilon client
  75 .SH "CERTIFICATES"
  76 Two levels of SSL certificates may be used in an Ipsilon instalation.
  77
  78 An X509 signing certificate is used by Ipsilon to sign SAML 2 messages. The public key of the certificate is passed in the SAML metadata exchanged between the Identity Provider and the Service Provider. This certificate and key are automatically generated.
  79
  80 Any page on the SP that will use the authentication provided by the IdP will need to be protected by SSL in order to access the secure cookie that the IdP provides. Ipsilon does not provide this certificate.
  81 .SH "EXAMPLES"
  82 Install a SAML 2 SP using the  IdP instance idp on idp.example.com.
  83
  84    # ipsilon\-client\-install \-\-saml\-idp\-metadata https://idp.example.com/idp/saml2/metadata \-\-saml\-auth /protected
  85
  86 Any unauthenticated request to /protected will trigger a redirect to the IdP for authentication.
  87
  88 Once the SP has been generated it needs to be registered with the IdP.
  89 .SH "EXIT STATUS"
  90 0 if the installation was successful
  91
  92 1 if an error occurred
  93 .SH "SEE ALSO"
  94 .BR ipsilon(7)