blob: f6ad52d4a2b3cb223d1b289b5bffe379b70aff61 [file] [log] [blame]
Nico Huber8700ab82023-06-25 10:14:44 +00001; :mode=ini:
2; $Id$
3;
4;
5; SimpleID identity file.
6;
7; This file contains all the data associated with an identity. It should
8; always be named username.identity, where username is the user name to be used
9; when logging into SimpleID.
10;
11; In this file, if a value contains non-numeric characters, you will need to
12; surround it with quotation characters.
13;
14
15;
16; The OpenID Identifier associated with this identity. This is typically a
17; URL, although the OpenID specifications allow the use of URIs and even XRIs.
18;
19; Relying parties must be able to resolve the identity to obtain the address
20; of this SimpleID installation.
21;
22; WARNING: If you change the OpenID Identifier after you have used it in
23; SimpleID, you will need to delete all files named 'identity-*.cache' in the
24; cache directory.
25;
26; Examples:
27; http://example.com/
28; http://example.com:8888/
29; http://example.com/myopenid
30; https://example.com:8080/myopenid
31;
32identity="https://id.miau.local/icon"
33
34;
35; The password associated with this identity.
36;
37; The password is encoded as follows:
38;
39; pass="hash:algorithm:other_params"
40;
41; There are three components to the password string. Only the first component
42; (the hash) is required, the other two are optional.
43;
44; 1. The hash of the password. For backwards compatibility reasons, the
45; default algorithm for hashing the password is MD5.
46;
47; However, you are strongly encouraged to use a much stronger password
48; hashing algorithm, such as PBKDF2 with a HMAC-SHA256 function and at least
49; 100,000 iterations.
50;
51; 2. The algorithm used to hash the password. If this is omitted, 'md5' is assumed.
52;
53; Allowed algorithms are:
54;
55; - md5
56; - sha1
57; - if the hash module is enabled, pbkdf2 and any algorithms available from that
58; module
59;
60; 3. Other parameters.
61;
62; For md5 and sha1, this is an optional salt used to hash the password. If
63; used, the password is appended by a colon character (:) then the salt before
64; a hash is calculated, that is:
65;
66; hash(password:salt)
67;
68; For pbkdf2, it is the underlying pseudorandom function, the number of
69; iterations and the salt, separated by colons.
70;
71; Examples (these contain the same password):
72; 1a79a4d60de6718e8e5b326e338ae533 ; MD5 hash and no salt
73; c3499c2729730a7f807efb8676a92dcb6f8a3f8f:sha1 ; SHA1 hash and no salt
74; f5e6ea5714945786623ad3932ccc757d::ideally-a-large-number-of-random-characters-to-use-as-salt ; MD5 hash with salt
75; 9bce4e6997c6f2590717686bd62f99e33d5c6e1c:sha1:ideally-a-large-number-of-random-characters-to-use-as-salt ; SHA1 hash with salt
76; c6e1aa5914c6e4e55fae69093afbc02e180810dcc7d3da9f863aa54f3d76e2c3:pbkdf2:sha256:100000:ideally-a-large-number-of-random-characters-to-use-as-salt ; PBKDF2
77;
78pass="9885d0ea104f04cb8a9299b8cf597baff16673dfa6fcee7fce9d98bb6868956d:pbkdf2:sha256:100000:uiaecubklb"
79
80;
81; Whether this user is given administrative privileges in SimpleID.
82;
83; This setting has no effect in the current version of SimpleID. However,
84; more functionality may be added to SimpleID in future versions which will
85; be restricted to SimpleID administrators.
86;
87; You should grant administrative privileges to at least one user.
88;
89; If you wish this user to be given administrative privileges, uncomment the
90; line below.
91;
92;administrator=1
93
94;
95; Advanced users only: SSL client certificates associated with this identity.
96;
97; You can associate SSL client certificates to this identity, so that you can
98; log in using certificates instead of supplying a user name or password.
99;
100; The SSL certicate is identified using two parameters:
101;
102; - the certificate's serial number
103; - the distinguished name of the certificate's issuer
104;
105; You can find out these two values using OpenSSL by running the following
106; commands (replacing the file name of the certificate as required):
107;
108; openssl x509 -noout -serial -in certificate.crt
109; openssl x509 -noout -issuer -in certificate.crt
110;
111; These two values are then joined together using a semicolon.
112;
113; This option is for advanced users only. Please see the documentation at
114; http://simpleid.org/docs/1/certauth/
115; for details on how to set this up.
116;
117; Note, you must also enable the certauth extension in SimpleID. To
118; do this, make sure the SIMPLEID_EXTENSIONS option in config.php contains
119; certauth
120
121; Example:
122;
123;[certauth]
124;cert[]="02A97C;/C=XX/O=Example CA/OU=Example CA Certificate Signing/CN=Example Client CA"
125
126
127;
128; OpenID Connect user information.
129;
130; If you want to provide personal data to OpenID Connect clients, uncomment the
131; section below and fill in your details.
132;
133; Note that you will need to supply your data in this section again even if you
134; have uncommented and filled in the Simple Registration Extension and/or
135; Attribute Exchange Extension information in the sections below. SimpleID
136; does not pick these up automatically.
137;
138; WARNING: The address fields below are only supported by PHP 5.3 or later.
139; Earlier versions of PHP are not able to read identity files with
140; associative arrays
141;
142;[user_info]
143;name="Example"
144;given_name="Example"
145;family_name="Example"
146;middle_name="Example"
147;nickname="Example"
148;profile="http://example.com/profile/example"
149;picture="http://example.com/profile/example.jpg"
150;website="http://example.com/blog/example"
151;email="example@example.com"
152;gender="male"
153;birthday="12/31/2000"
154;zoneinfo="Australia/Sydney"
155;locale="en-AU"
156;phone_number="+61400000000"
157;address["formatted"]="1 George Street, Sydney NSW 2000, Australia"
158;address["street_address"]="1 George Street"
159;address["locality"]="Sydney"
160;address["region"]="NSW"
161;address["postal_code"]="2000"
162;address["country"]="Australia"
163
164
165;
166; Simple Registration Extension data.
167;
168; If you want to provide registration data to relying parties which support the
169; Simple Registration Extension, uncomment the section below and fill
170; in your details.
171;
172; Further information on the Simple Registration Extension can be found at
173; http://simpleid.org/docs/1/extensions-bundled/#sreg
174;
175; Note, you must also enable the Simple Registration Extension in SimpleID. To
176; do this, make sure the SIMPLEID_EXTENSIONS option in config.php contains
177; sreg
178;
179[sreg]
180nickname="icon"
181email="nico.h@gmx.de"
182fullname="Nico Huber"
183;dob="2000-00-00"
184;gender="M"
185;postcode="1234"
186country="de"
187;language="au"
188timezone="Europe/Berlin"
189
190
191;
192; Attribute Exchange Extension data.
193;
194; If you want to provide personal identity information data to relying parties
195; which support the Attribute Exchange Extension, uncomment the section below
196; and fill in your details.
197;
198; The format of this section is attribute type URI=attribute value. Examples
199; are given below.
200;
201; For a full list of attributes, see http://openid.net/specs/openid-attribute-properties-list-1_0-01.html
202;
203; Note if you have already uncommented and filled out the OpenID Connect user
204; information and/or Simple Registration Extension data above, you do not need
205; to fill out the corresponding attributes again in the section below. SimpleID
206; will pick these up automatically, including:
207;
208; http://axschema.org/namePerson/friendly
209; http://axschema.org/contact/email
210; http://axschema.org/namePerson
211; http://axschema.org/birthDate
212; http://axschema.org/person/gender
213; http://axschema.org/contact/postalCode/home
214; http://axschema.org/contact/country/home
215; http://axschema.org/pref/language
216; http://axschema.org/pref/timezone
217; http://openid.net/schema/namePerson/friendly
218; http://openid.net/schema/contact/internet/email
219; http://openid.net/schema/gender
220; http://openid.net/schema/contact/postalCode/home
221; http://openid.net/schema/contact/country/home
222; http://openid.net/schema/language/pref
223; http://openid.net/schema/timezone
224;
225; Note, you must also enable the Attribute Exchange Extension in SimpleID. To
226; do this, make sure the SIMPLEID_EXTENSIONS option in config.php contains
227; ax
228;
229;[ax]
230;http://openid.net/schema/company/name="Example Company Limited"
231;http://openid.net/schema/company/title="Managing Director"
232;http://openid.net/schema/contact/web/blog="http://simpleid.org/"
233