First stab at an example config file.
[java-idp.git] / src / conf / origin.properties
1 ###################################################################################
2 #
3 # Handle Service Configuration
4 #
5 ###################################################################################
6
7 ##### General Configuration #####
8
9  # [Required] Name of this Handle Service (usually a dns name)
10  #edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer = shib2.internet2.edu
11
12  # [Required] The name of this origin site (a URI)
13  #edu.internet2.middleware.shibboleth.hs.HandleServlet.siteName = urn:mace:inqueue:shibdev.edu
14
15  # [Required] URL at which the corresponding Attribute Authority can be reached
16  #edu.internet2.middleware.shibboleth.hs.HandleServlet.AAUrl = http://host.test.edu/shibboleth/AA
17
18  # [Optional] HTTP Request Header to get principal name from (defaults to REMOTE_USER)
19  #edu.internet2.middleware.shibboleth.hs.HandleServlet.username = REMOTE_USER
20  
21  # [Optional] URI identifying the authentication mechanism that is used by the HS
22  #edu.internet2.middleware.shibboleth.hs.HandleServlet.authMethod = urn:oasis:names:tc:SAML:1.0:am:password
23
24 ##### Assertion Signing #####
25
26  # [Required] Location of a Java keystore containing an X509 certificate
27  # and matching key.  Used to sign assertions made by this HS
28  #edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePath = /conf/keystore.jks
29
30  # [Required] Password for the keystore
31  #edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePassword = shibhs
32
33  # [Required] Keystore alias for the private key
34  #edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias = shibhs
35
36  # [Required] Password for the private key
37  #edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyPassword = shibhs
38
39  # [Optional] Keystore alias for the X509 certificate (Defaults to the private key alias)
40  #edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias = shibhs
41
42
43 ###################################################################################
44 #
45 # Attribute Authority Configuration
46 #
47 ###################################################################################
48
49 ##### General Configuration #####
50
51  # [Required] Name of this Attribute Authority (usually a dns name)
52  #edu.internet2.middleware.shibboleth.aa.AAServlet.authorityName = shib2.internet2.edu
53  
54  # [Optional] Set to true if the Attribute Authority should pass internal error messages to 
55  # the SHAR (for debugging purposes) (defaults to false)
56  #edu.internet2.middleware.shibboleth.aa.AAServlet.passThruErrors = false
57
58 ##### Attribute Resolution #####
59
60  # [Optional] Attribute Resolver configuration (Defaults to /conf/resolver.xml)
61  #edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver.ResolverConfig = /conf/resolver.xml
62
63 ##### Attribute Release Policies #####
64
65  # [Required] Arp Repository Implementation
66  edu.internet2.middleware.shibboleth.aa.arp.ArpRepository.implementation = edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository
67
68    ### Parameters for edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository ###
69         
70    # [Required if active] Path from which Policies can be loaded
71    edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path = /conf/arps/
72         
73    # [Optional] Time in seconds for which Release Policies should be cached
74    # (Defaults to 0 or "no caching")
75    edu.internet2.middleware.shibboleth.aa.arp.BaseArpRepository.ArpTTL = 300
76
77
78 ###################################################################################
79 #
80 # Shared Configuration
81 #
82 ###################################################################################
83
84 ##### Attribute Query Handle Repository #####
85
86  # [Optional] Specifes an implementation to be used for the HS and AA to share AQHs (Defaults to Memory provider)
87  edu.internet2.middleware.shibboleth.hs.HandleRepository.implementation = edu.internet2.middleware.shibboleth.hs.provider.MemoryHandleRepository
88  #edu.internet2.middleware.shibboleth.hs.HandleRepository.implementation = edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository
89
90    ### Parameters for edu.internet2.middleware.shibboleth.hs.provider.MemoryHandleRepository ###
91
92    # [Optional] Time in seconds for which issued AQHs are valid (Defaults to 1800 or 30 minutes)
93    #edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL = 1000
94
95    ### Parameters for edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository ###
96         
97    # [Required if active] Location of a Java keystore containing a Triple DES secret key.  
98    # Used to encrypt the principal's identifiers
99    #edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePath = /conf/handle.jks
100
101    # [Required if active] Password for the keystore
102    #edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePassword = shibhs
103
104    # [Required if active] Keystore alias for the secret key
105    #edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyAlias = handleKey
106
107    # [Required if active] Password for the private key
108    #edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStoreKeyPassword = shibhs
109
110    # [Optional] Time in seconds for which issued AQHs are valid (Defaults to 1800 or 30 minutes)
111    #edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL = 1000
112
113 ##### Federation Configuration #####
114
115  #[Optional] URI corresponding to the federation this origin operates under (defaults to the InQueue policy)
116  #edu.internet2.middleware.shibboleth.audiences = urn:mace:inqueue