doc/InQueue.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3         <head>
   4                 <title>InQueue Federation Policy and Configuration Guidelines</title>
   5                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6                 <style type="text/css">
   7
   8                         html
   9                         {
  10                                 background-color: #FFFFFF;
  11                                 color: #000000;
  12                                 margin: .5em;
  13                         }
  14                         a:visited
  15                         {
  16                                 color: #999999;
  17                         }
  18                         a:link
  19                         {
  20                                 color: #990000;
  21                         }
  22                         a:active
  23                         {
  24                                 color: #440000;
  25                         }
  26                         dl
  27                         {
  28                                 background-color: #DDDDDD;
  29                                 background-image: none;
  30                                 margin: 5px;
  31                                 padding: 0px;
  32                                 border-style: solid;
  33                                 border-bottom-width: 2px;
  34                                 border-top-width: 2px;
  35                                 border-left-width: 2px;
  36                                 border-right-width: 2px;
  37                         }
  38                         dt
  39                         {
  40                                 background-color: #DDDDDD;
  41                                 background-image: none;
  42                                 margin: 1px;
  43                                 padding: 1px;
  44                         }
  45                         dd
  46                         {
  47                                 background-color: #DDDDDD;
  48                                 background-image: none;
  49                                 margin: 0px;
  50                                 padding: 1px;
  51                         }
  52                         .attribute
  53                         {
  54                                 font-size: 115%;
  55                                 font-color: #000000;
  56                                 text-align: left;
  57                                 background-color: #DDDDDD;
  58                                 border: 1px black inset;
  59                                 background-image: none;
  60                                 margin: 0px;
  61                                 padding: 2px;
  62                         }
  63                         .value
  64                         {
  65                                 font-color: #000000;
  66                                 text-align: left;
  67                                 background-color: #EEEEEE;
  68                                 background-image: none;
  69                                 padding-top: 0em;
  70                                 padding-bottom: 0.5em;
  71                                 padding-right: 1em;
  72                                 padding-left: 5em;
  73                                 border-style: solid;
  74                                 border-bottom-width: none;
  75                                 border-top-width: none;
  76                                 border-left-width: 1px;
  77                                 border-right-width: 1px;
  78                         }
  79                         .attributeopt
  80                         {
  81                                 font-size: 115%;
  82                                 font-color: #000000;
  83                                 text-align: left;
  84                                 background-color: #BCBCEE;
  85                                 border: 1px black inset;
  86                                 background-image: none;
  87                                 margin: 0px;
  88                                 padding: 2px;
  89                         }
  90                         .valueopt
  91                         {
  92                                 font-color: #000000;
  93                                 text-align: left;
  94                                 background-color: #DDDDFF;
  95                                 background-image: none;
  96                                 padding-top: 0em;
  97                                 padding-bottom: 0.5em;
  98                                 padding-right: 1em;
  99                                 padding-left: 5em;
 100                                 border-style: solid;
 101                                 border-bottom-width: none;
 102                                 border-top-width: none;
 103                                 border-left-width: 1px;
 104                                 border-right-width: 1px;
 105                         }
 106                         .attributelong
 107                         {
 108                                 font-size: 85%;
 109                                 font-color: #000000;
 110                                 text-align: left;
 111                                 background-color: #DDDDDD;
 112                                 border: 1px black inset;
 113                                 background-image: none;
 114                                 margin: 0px;
 115                                 padding: 2px;
 116                         }
 117                         .attributeoptlong
 118                         {
 119                                 font-size: 85%;
 120                                 font-color: #000000;
 121                                 text-align: left;
 122                                 background-color: #BCBCEE;
 123                                 border: 1px black inset;
 124                                 background-image: none;
 125                                 margin: 0px;
 126                                 padding: 2px;
 127                         }
 128                         .demo
 129                         {
 130                                 background-color: #EEEEEE;
 131                                 padding: 3px;
 132                         }
 133                         .fixedwidth
 134                         {
 135                                 font-family: monospace;
 136                                 font-size: 90%;
 137                                 font-color: #121212;
 138                         }
 139
 140                 </style></head><body link="red" vlink="red" alink="black" bgcolor="white">
 141                 InQueue Federation Policy and Configuration Guidelines<br>
 142                 Version 1.1<br />
 143                 August 4, 2003<br />
 144
 145                 <h3>InQueue Federation Policy and Configuration Guidelines</h3>
 146
 147                 <h4>1.  Introduction to InQueue</h4>
 148                 <blockquote><p>
 149                         The InQueue Federation, operated by Internet2, is designed for
 150                         organizations that are becoming familiar with the Shibboleth software
 151                         package and the federated trust model.  InQueue provides the basic
 152                         services needed for a federation using Shibboleth:</p>
 153
 154                         <ul>
 155                                 <li>maintenance and distribution of participating site description and
 156                                 security files;</li>
 157                                 <li>a central WAYF ("where are you from") web site;</li>
 158                                 <li>specification of operational procedures and policies, including
 159                                 user data (attribute) definitions; and</li>
 160                                 <li>example target and origin sites with which to test
 161                                 interoperability.</li>
 162                         </ul>
 163
 164                         <p>Participating in InQueue permits an organization to learn about the
 165                         Shibboleth software via the experience of multi-party federated access,
 166                         while integrating its services into the organization's procedures and
 167                         policies.</p>
 168
 169                         <p>The InQueue federation is specifically <b>not</b> intended to support
 170                         production-level end-user access to protected resources.  Organizations
 171                         operating target sites are strongly discouraged from making sensitive or
 172                         valuable resources available via the Federation.</p>
 173                 </blockquote>
 174
 175                 <h4>2.  InQueue Policies</h4>
 176
 177                 <h4>2.1  Participation</h4>
 178
 179                 <blockquote><p>An organization may join InQueue as an origin, as a
 180                         target, or both.
 181                         Participants are expected to be authorized representatives of
 182                         their organization.  Internet2 reserves the right to make final
 183                         decisions about participation in the Federation.</p>
 184
 185                         <p>InQueue is intended to serve as a primary federation
 186                         for an organization only during the period an
 187                         organization is learning about Shibboleth and federated
 188                         operations.  Upon completion of this period, the
 189                         organization is expected to join a Federation (or some
 190                         other management solution) that meets its long-term
 191                         operational needs. </p>
 192
 193                         <p>By joining InQueue, an organization agrees that the
 194                         Federation can list their name on the Federation web
 195                         site as a member of the Federation.</p>
 196
 197                         <p>In joining InQueue, an organization will make a good
 198                         faith effort to maintain a web page describing their use
 199                         of Shibboleth. This page will be linked from the
 200                         Federation member list.</p>
 201
 202                         </blockquote>
 203
 204                         <h4>2.2  Data management</h4>
 205
 206                         <blockquote><p>
 207                                 By participating, origins agree that all attributes sent
 208                                 to targets in the Federation to the best of their knowledge accurately
 209                                 represent information about the authenticated individual accessing the
 210                                 target resource.</p>
 211
 212                                 <p>Targets agree to dispose of all received
 213                                 attributes properly by not mis-using them, aggregating them, or
 214                                 sharing them with other organizations.</p></blockquote>
 215
 216                         <h4>2.3  Security management</h4>
 217
 218                         <blockquote><p>InQueue distributes a set of root certificates for
 219                                 issuers from which server certificates may be obtained to identify
 220                                 InQueue server components.
 221                                 Additionally, sites with certificates not rooted
 222                                 in one of these trusted roots may have these certificates added to the
 223                                 appropriate trust file.  Targets must have a certificate signed by an
 224                                 acceptible CA.  The list of certificate authorities used by
 225                                 InQueue is:</p>
 226                                 <ul type="circle">
 227                                         <li><a href="http://www.verisign.com/">Verisign/RSA Secure Server CA</a></li>
 228                                         <li><a href="http://bossie.doit.wisc.edu/cert/i2server">Internet2
 229                                                 HEPKI Test CA</a></li>
 230                                         <li><a href="http://www.cren.net/crenca/">CREN CA</a></li>
 231                                 </ul>
 232                         </blockquote>
 233
 234                         <h4>2.4  Attributes</h4>
 235                         <blockquote><p>The InQueue
 236                                 Federation specifies a set of attribute definitions to support basic
 237                                 attribute-based authorization.</p>
 238                                 <ol>
 239                                 <li>If a Federation member sends or receives an Attribute Assertion
 240                                 containing the InQueue policy uri and referencing one of the listed
 241                                 attributes,
 242                                 the syntax and semantics of the associated attribute value should
 243                                 conform
 244                                 to the definitions specified in the <a href="http://www.educause.edu/eduperson/">EduPerson specification 2002/10</a>
 245
 246                                 <ul type="circle">
 247                                         <li>eduPersonPrincipalName</li>
 248                                         <li>eduPersonEntitlement</li>
 249                                         <li>eduPersonAffiliation (expressed in a slightly different form via
 250                                         a new attribute called eduPersonScopedAffiliation)</li>
 251                                 </ul>
 252                                 <li>If a Federation member sends or receives an Attribute Assertion
 253                                 containing the InQueue policy uri and referencing one of the listed
 254                                 attributes,
 255                                 the syntax and semantics of the associated attribute value should
 256                                 conform
 257                                 to the definitions specified in the relevant <a href="http://www/ietf.org">IETF</a> RFCs.
 258
 259                                 <ul type="circle">
 260                                         <li>cn
 261                                         <li>sn
 262                                         <li>telephoneNumber
 263                                         <li>title
 264                                         <li>initials
 265                                         <li>description
 266                                         <li>carLicense
 267                                         <li>departmentNumber
 268                                         <li>displayName
 269                                         <li>employeeNumber
 270                                         <li>employeeType
 271                                         <li>preferredLanguage
 272                                         <li>manager
 273                                         <li>roomNumber
 274                                         <li>seeAlso
 275                                         <li>facsimileTelephoneNumber
 276                                         <li>street
 277                                         <li>postOfficeBox
 278                                         <li>postalCode
 279                                         <li>st
 280                                         <li>givenName
 281                                         <li>l
 282                                         <li>businessCategory
 283                                         <li>ou
 284                                         <li>physicalDeliveryOfficeName
 285                                 </ul>
 286                                 <li>If a Federation member sends or receives an eduPersonEntitlement Attribute Assertion
 287                                 containing the InQueue policy uri and containing one of the listed
 288                                 values,
 289                                 the syntax and semantics of the associated attribute value should
 290                                 conform
 291                                 to these definitions
 292
 293                                 <ul type="circle">
 294                                         <li>urn:mace:incommon:entitlement:common:1
 295                                         <p>The person possesses an eduPersonAffiliation value of faculty, staff,  or student, or qualifies as a "library walk-in".
 296
 297                                 </ul>
 298                                 </ol>
 299                         </blockquote>
 300
 301                         <h4>3.  Joining InQueue</h4>
 302
 303                         <blockquote><p>To join InQueue, origins <a href="mailto:shib-support@internet2.edu?subject=Shib%20Origin%20Site%%0D%20%2020Application"> submit a request to
 304                                         shib-support@internet2.edu</a> containing the following
 305                                 information:</p></blockquote>
 306
 307                         <blockquote>
 308                                 <ul type="circle">
 309                                         <li>Domain Name of the origin site (e.g., Ohio State's is
 310                                         "osu.edu").</li>
 311                                         <li>Complete URL to access the Shibboleth Handle Service at the site.</li>
 312                                         <li>The CN (usually the hostname) of the HS's certificate's subject.
 313                                         This should also be the value of <span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.
 314                                                 HandleServlet.issuer</span> in <span class="fixedwidth">origin.properties</span>.</li>
 315                                         <li>Any shorthand aliases the WAYF should support for the origin
 316                                         site (e.g., Ohio State, OSU, Buckeyes)</li>
 317                                         <li>Contact names and addresses for technical and administrative
 318                                         issues.</li>
 319                                         <li>The URL of an error page that users selecting this origin from
 320                                         the WAYF may be referred to by targets if Shibboleth
 321                                         malfunctions. (optional)</li>
 322                                         <li>If the HS's certificate is not issueed by one of the root CAs
 323                                         used
 324                                         by InQueue, then it must be submitted in Base64-encoded DER (aka
 325                                         "PEM") format.</li>
 326                                         <li>(optional) Briefly describe the organization's planned uses of Shibboleth.
 327                         </ul></blockquote>
 328
 329                         <blockquote><p>To join InQueue, targets must <a href="mailto:shib-support@internet2.edu?subject=Shib%20Target%20Site%%0D%20%2020Application"> submit a basic application to
 330                                         shib-support@internet2.edu</a> containing the following
 331                                 information:</p></blockquote>
 332
 333                         <blockquote>
 334                                 <ul type="circle">
 335                                         <li>The name of the organization</li>
 336                                         <li>Contact names and addresses for both administrative and
 337                                         technical purposes</li>
 338                                 </ul>
 339                         </blockquote>
 340
 341                         <h4>4.  Configuration for Using InQueue</h4>
 342
 343                         <blockquote><p>Once your site is accepted into and added to InQueue,
 344                                 the following configuration parameters must be entered to ensure
 345                                 interoperability and compliance with federation guidelines.  Consult
 346                                 the Shibboleth Deploy Guides for further information on these fields
 347                                 and on <span class="fixedwidth">origin.properties</span> and <span class="fixedwidth">shibboleth.ini</span>.</p></blockquote>
 348
 349                         <blockquote><h5>4.a. Origins:</h5>
 350
 351                                 <dl><dd class="attribute"><span class="fixedwidth">edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName</span>
 352                                         </dd><dd class="value"><p>Must be populated with a URI that will
 353                                         be assigned by InQueue when you are accepted into the
 354                                         federation.</p></dd><dd class="attribute"><span class="fixedwidth">edu.internet2.middleware.shibboleth.audiences</span>
 355                                         </dd><dd class="value"><p>This field must contain InQueue's <span class="fixedwidth">urn:mace:inqueue</span> URI, and may contain other federation URIs as well.</p></dd></dl>
 356                                 </blockquote>
 357
 358                                 <blockquote><h5>4.b. Targets:</h5>
 359
 360                                         <dl><dd class="attribute"><span class="fixedwidth">wayfURL</span>
 361                                                 </dd><dd class="value"><p>This field must be set to InQueue's simple WAYF at <span class="fixedwidth">https://wayf.internet2.edu/InQueue/WAYF</span>.</p></dd><dd class="attribute"><span class="fixedwidth">[policies]</span>
 362                                                 </dd><dd class="value"><p>This section must contain <span class="fixedwidth">InQueue = urn:mace:inqueue</span>, and may
 363                                                 contain other federation name/value pairs as well.</p></dd>
 364                                         </dl>
 365                                 </blockquote>
 366
 367                                 <blockquote><h5>4.b.i. Refreshing Federation Metadata:</h5>
 368                                         <p>Once your target site is accepted into the InQueue federation, it is necessary that you periodically
 369                                         update the target's federation metadata.  This metadata includes information used to identify and authenticate
 370                                         InQueue sites.</p>
 371
 372                                         <p>InQueue's metadata is digitally signed, so the first step is to obtain the InQueue signing certificate.
 373                                         It can be downloaded from <span class="fixedwidth">http://wayf.internet2.edu/InQueue/internet2.pem
 374                                         </span> and has a fingerprint of:</p>
 375                                         <p><span class="fixedwidth">b4 42 6c 1e 8b 7d 8e b3 68 03 00 e4 c4 57 dd 74 89 f8 9a 80</span>.</p>
 376
 377                                         <p>The following commands can be used to obtain the federation's metadata:</p>
 378                                         <p><span class="fixedwidth"> $ cd /opt/shibboleth/etc/shibboleth</span></p>
 379                                         <p><span class="fixedwidth">$ ../../bin/siterefresh --url http://wayf.internet2.edu/InQueue/sites.xml
 380                                                 --out sites.xml --cert internet2.pem</span></p>
 381                                                 <p><span class="fixedwidth">$ ../../bin/siterefresh --url http://wayf.internet2.edu/InQueue/trust.xml
 382                                                         --out trust.xml --cert internet2.pem</span></p>
 383                                 </blockquote>
 384
 385                                 <h4>5.  Testing</h4>
 386                                 <blockquote><p>A <a href="https://wayf.internet2.edu/shibboleth/sample.jsp">sample shibboleth target</a>
 387                                         is available for testing newly installed origin sites.  New targets can make use of a sample origin,
 388                                         which is listed as "Example State University" on the InQueue WAYF ( Username: demo / Password: demo ).</p></blockquote>
 389
 390                 </body></html>
 391