-
Notifications
You must be signed in to change notification settings - Fork 0
/
openid-attribute-exchange.html
1411 lines (1196 loc) · 54.7 KB
/
openid-attribute-exchange.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en"><head><title>Draft 01: OpenID Attribute Exchange 1.1 - Draft 02</title>
<meta http-equiv="Expires" content="Wed, 09 Dec 2009 14:51:19 +0000">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="OpenID Attribute Exchange 1.1 - Draft 02">
<meta name="generator" content="xml2rfc v1.34 (http://xml.resource.org/)">
<style type='text/css'><!--
body {
font-family: verdana, charcoal, helvetica, arial, sans-serif;
font-size: small; color: #000; background-color: #FFF;
margin: 2em;
}
h1, h2, h3, h4, h5, h6 {
font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
font-weight: bold; font-style: normal;
}
h1 { color: #900; background-color: transparent; text-align: right; }
h3 { color: #333; background-color: transparent; }
td.RFCbug {
font-size: x-small; text-decoration: none;
width: 30px; height: 30px; padding-top: 2px;
text-align: justify; vertical-align: middle;
background-color: #000;
}
td.RFCbug span.RFC {
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
font-weight: bold; color: #666;
}
td.RFCbug span.hotText {
font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
font-weight: normal; text-align: center; color: #FFF;
}
table.TOCbug { width: 30px; height: 15px; }
td.TOCbug {
text-align: center; width: 30px; height: 15px;
color: #FFF; background-color: #900;
}
td.TOCbug a {
font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
font-weight: bold; font-size: x-small; text-decoration: none;
color: #FFF; background-color: transparent;
}
td.header {
font-family: arial, helvetica, sans-serif; font-size: x-small;
vertical-align: top; width: 33%;
color: #FFF; background-color: #666;
}
td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
td.author-text { font-size: x-small; }
/* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
a.info {
/* This is the key. */
position: relative;
z-index: 24;
text-decoration: none;
}
a.info:hover {
z-index: 25;
color: #FFF; background-color: #900;
}
a.info span { display: none; }
a.info:hover span.info {
/* The span will display just on :hover state. */
display: block;
position: absolute;
font-size: smaller;
top: 2em; left: -5em; width: 15em;
padding: 2px; border: 1px solid #333;
color: #900; background-color: #EEE;
text-align: left;
}
a { font-weight: bold; }
a:link { color: #900; background-color: transparent; }
a:visited { color: #633; background-color: transparent; }
a:active { color: #633; background-color: transparent; }
p { margin-left: 2em; margin-right: 2em; }
p.copyright { font-size: x-small; }
p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
ol.text { margin-left: 2em; margin-right: 2em; }
ul.text { margin-left: 2em; margin-right: 2em; }
li { margin-left: 3em; }
/* RFC-2629 <spanx>s and <artwork>s. */
em { font-style: italic; }
strong { font-weight: bold; }
dfn { font-weight: bold; font-style: normal; }
cite { font-weight: normal; font-style: normal; }
tt { color: #036; }
tt, pre, pre dfn, pre em, pre cite, pre span {
font-family: "Courier New", Courier, monospace; font-size: small;
}
pre {
text-align: left; padding: 4px;
color: #000; background-color: #CCC;
}
pre dfn { color: #900; }
pre em { color: #66F; background-color: #FFC; font-weight: normal; }
pre .key { color: #33C; font-weight: bold; }
pre .id { color: #900; }
pre .str { color: #000; background-color: #CFF; }
pre .val { color: #066; }
pre .rep { color: #909; }
pre .oth { color: #000; background-color: #FCF; }
pre .err { background-color: #FCC; }
/* RFC-2629 <texttable>s. */
table.all, table.full, table.headers, table.none {
font-size: small; text-align: center; border-width: 2px;
vertical-align: top; border-collapse: collapse;
}
table.all, table.full { border-style: solid; border-color: black; }
table.headers, table.none { border-style: none; }
th {
font-weight: bold; border-color: black;
border-width: 2px 2px 3px 2px;
}
table.all th, table.full th { border-style: solid; }
table.headers th { border-style: none none solid none; }
table.none th { border-style: none; }
table.all td {
border-style: solid; border-color: #333;
border-width: 1px 2px;
}
table.full td, table.headers td, table.none td { border-style: none; }
hr { height: 1px; }
hr.insert {
width: 80%; border-style: none; border-width: 0;
color: #CCC; background-color: #CCC;
}
--></style>
</head>
<body>
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
<tr><td class="header">Draft 01</td><td class="header">D. Hardt</td></tr>
<tr><td class="header"> </td><td class="header">J. Bufu</td></tr>
<tr><td class="header"> </td><td class="header">Sxip Identity</td></tr>
<tr><td class="header"> </td><td class="header">J. Hoyt</td></tr>
<tr><td class="header"> </td><td class="header">JanRain</td></tr>
<tr><td class="header"> </td><td class="header">N. Sakimura</td></tr>
<tr><td class="header"> </td><td class="header">Nomura Research Institute, Ltd.</td></tr>
<tr><td class="header"> </td><td class="header">December 9, 2009</td></tr>
</table></td></tr></table>
<h1><br />OpenID Attribute Exchange 1.1 - Draft 02</h1>
<h3>Abstract</h3>
<p>
OpenID Attribute Exchange is an OpenID service extension for
exchanging identity information between endpoints. Messages for
retrieval and storage of identity information are provided.
</p><a name="toc"></a><br /><hr />
<h3>Table of Contents</h3>
<p class="toc">
<a href="#anchor1">1.</a>
Terminology<br />
<a href="#anchor2">1.1.</a>
Definitions and Conventions<br />
<a href="#anchor3">2.</a>
Overview<br />
<a href="#anchor4">3.</a>
Information Model<br />
<a href="#identifier-definition">3.1.</a>
Subject Identifier<br />
<a href="#attribute-name-definition">3.2.</a>
Attribute Type Identifier<br />
<a href="#attribute-value-definition">3.3.</a>
Attribute Value<br />
<a href="#attribute-specific-encodings">3.3.1.</a>
Attribute-Specific Encodings<br />
<a href="#anchor5">4.</a>
Discovery<br />
<a href="#fetch">5.</a>
Fetch Message<br />
<a href="#fetch_request">5.1.</a>
Fetch Request Format<br />
<a href="#fetch_response">5.2.</a>
Fetch Response Format<br />
<a href="#store">6.</a>
Store Message<br />
<a href="#store_request">6.1.</a>
Store Request Format<br />
<a href="#store_response">6.2.</a>
Store Response Format<br />
<a href="#anchor6">6.2.1.</a>
Storage Success<br />
<a href="#anchor7">6.2.2.</a>
Storage Failure<br />
<a href="#anchor8">7.</a>
Default Schemas<br />
<a href="#anchor9">7.1.</a>
Mandatory Data Type<br />
<a href="#anchor10">8.</a>
Security Considerations<br />
<a href="#anchor11">9.</a>
Acknowledgements<br />
<a href="#rfc.references1">10.</a>
References<br />
<a href="#rfc.references1">10.1.</a>
Normative References<br />
<a href="#rfc.references2">10.2.</a>
Non-normative References<br />
<a href="#rfc.authors">§</a>
Authors' Addresses<br />
</p>
<br clear="all" />
<a name="anchor1"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.1"></a><h3>1.
Terminology</h3>
<p>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described
in <a class='info' href='#RFC2119'>[RFC2119]<span> (</span><span class='info'>Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” March 1997.</span><span>)</span></a>.
</p>
<a name="anchor2"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.1.1"></a><h3>1.1.
Definitions and Conventions</h3>
<p>
</p>
<blockquote class="text"><dl>
<dt>User:</dt>
<dd>
Also referred to as "End User" or "Subject".
A person with a digital identity who participates in
OpenID-based identity information exchanges using their
client software, typically a web browser.
</dd>
<dt>Identity Data:</dt>
<dd>
A property of a digital identity in which the Property
Name and Property Value are represented as a name-value
pair.
</dd>
<dt>Attribute</dt>
<dd>
The base of the information model used to describe the
Identity Data, for the purpose of exchanging it.
</dd>
<dt>Persona:</dt>
<dd>
A subset of the user's identity data. A user can have
multiple personas as part of their identity. For example,
a user might have a work persona and a home persona.
</dd>
<dt>OpenID Provider:</dt>
<dd>
Also called "OP" or "Server". An OpenID Authentication
server on which a Relying Party relies for an assertion
that the end user controls an Identifier.
</dd>
<dt>Relying Party:</dt>
<dd>
Also called "RP" or "Consumer". A Web application that
wants proof that the end user controls an Identifier,
and requests identity data associated with the end user.
</dd>
</dl></blockquote><p>
</p>
<p>
All OpenID Attribute Exchange messages MUST contain the
following extension namespace declaration, as specified
in the Extensions section of OpenID-Authentication-2.0:
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
openid.ns.<extension_alias>=http://openid.net/srv/ax/1.1
</pre></div>
<p>
The actual extension namespace alias should be determined
on a per-message basis by the party composing the messages,
in such a manner as to avoid conflicts between multiple
extensions. For the purposes of this document, the extension
namespace alias for the attribute exchange service will be "ax".
</p>
<a name="anchor3"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.2"></a><h3>2.
Overview</h3>
<p>
The attribute exchange service extension is identified by the
URI "http://openid.net/srv/ax/1.1". This URI MUST be specified in the extension
namespace declaration.
</p>
<p>
An attribute is a unit of personal identity information that
is identified by a unique URI. It may refer to any kind of
information. A reference example of defining attribute types
is provided by <a class='info' href='#OpenID.axschema'>[OpenID.axschema]<span> (</span><span class='info'>Hardt, D., “Schema for OpenID Attribute Exchange,” May 2007.</span><span>)</span></a>.
</p>
<p>
This service extension defines two message types for
transferring attributes: fetch (see <a class='info' href='#fetch'>Section 5<span> (</span><span class='info'>Fetch Message</span><span>)</span></a>)
and store (see <a class='info' href='#store'>Section 6<span> (</span><span class='info'>Store Message</span><span>)</span></a>). Fetch retrieves
attribute information from an OpenID Provider, while store
saves or updates attribute information on the OpenID
Provider. Both messages originate from the Relying Party
and are passed to the OpenID Provider via the user agent
as per the OpenID Authentication protocol specification.
</p>
<p>
The request parameters detailed here MUST be sent using the
<a class='info' href='#OpenID.authentication-2.0'>[OpenID.authentication‑2.0]<span> (</span><span class='info'>specs@openid.net, “OpenID Authentication 2.0 - Final,” August 2007.</span><span>)</span></a> extension mechanism.
</p>
<a name="anchor4"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3"></a><h3>3.
Information Model</h3>
<p>
The OpenID Attribute Exchange service extension provides a
mechanism for moving identity information between sites, as
such its information model is simple:
</p>
<blockquote class="text">
<p>An attribute is associated with a Subject Identifier
</p>
<p>An attribute has a type identifier and a value
</p>
<p>An attribute type identifier is a URI
</p>
<p>An attribute value can be any kind of data.
</p>
</blockquote><p>
</p>
<a name="identifier-definition"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3.1"></a><h3>3.1.
Subject Identifier</h3>
<p>
An identifier for a set of attributes. It MUST be a URI. The
subject identifier corresponds to the end-user identifier in
the authentication portion of the messages. In other words,
the subject of the identity attributes in the attribute
exchange part of the message is the same as the end-user in
the authentication part. The subject identifier is not
included in the attribute exchange.
</p>
<a name="attribute-name-definition"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3.2"></a><h3>3.2.
Attribute Type Identifier</h3>
<p>
An attribute type identifier MUST be a URI, which is used
for referring to property values.
</p>
<p>
If an attribute type identifier URI can be resolved then it
MAY be dereferenced to retrieve a description of the
property. OpenID Providers can use the metadata obtained
through dereferencing new or unknown attribute types to
dynamically assist the user in providing the attribute.
</p>
<p>
This provides for flexibility and extensibility. Flexibility
in that both URNs and URLs can be used to refer to property
values. Extensibility allows any individual site, or
consortium of sites, to define their own attribute types
with agreements on the syntax and semantics of their
associated attribute values.
</p>
<p>
<a class='info' href='#OpenID.axschema'>[OpenID.axschema]<span> (</span><span class='info'>Hardt, D., “Schema for OpenID Attribute Exchange,” May 2007.</span><span>)</span></a> outlines an example method
of defining new attribute type URIs, and also provides a set
of attribute types with their associated metadata schema and
data formats.
</p>
<a name="attribute-value-definition"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3.3"></a><h3>3.3.
Attribute Value</h3>
<p>
A attribute value MUST be a <a class='info' href='#RFC3629'>UTF-8<span> (</span><span class='info'>Yergeau, F., “UTF-8, a transformation format of ISO 10646,” November 2003.</span><span>)</span></a> [RFC3629]
string. In order to comply with the data formats defined by
the underlying <a class='info' href='#OpenID.authentication-2.0'>[OpenID.authentication‑2.0]<span> (</span><span class='info'>specs@openid.net, “OpenID Authentication 2.0 - Final,” August 2007.</span><span>)</span></a>
protocol, attribute values MUST NOT contain newlines
(UCS codepoint 10, "\n").
</p>
<p>
OpenID Attribute Exchange can be used to transfer any kind
of data. If the data contains newlines, is not a UTF-8 string
or it is so desired by the parties transferring the data,
the data MUST be encoded to a UTF-8 string without newlines.
</p>
<a name="attribute-specific-encodings"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.3.3.1"></a><h3>3.3.1.
Attribute-Specific Encodings</h3>
<p>
Attribute-specific encodings can be defined using the
attribute metadata descriptions and may be applied by
the protocol layer above OpenID Attribute Exchange.
</p>
<p>
Optionally, attribute-specific encodings may use language
tags <a class='info' href='#OpenID.value-lang-1.0'>[OpenID.value‑lang‑1.0]<span> (</span><span class='info'>Wahl, M., “Language Tags for OpenID Values,” April 2007.</span><span>)</span></a> for
localization.
</p>
<a name="anchor5"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.4"></a><h3>4.
Discovery</h3>
<p>
Discovery of the attribute exchange service extension is
achieved via the mechanism described in <a class='info' href='#OpenID.authentication-2.0'>[OpenID.authentication‑2.0]<span> (</span><span class='info'>specs@openid.net, “OpenID Authentication 2.0 - Final,” August 2007.</span><span>)</span></a>. The attribute exchange
namespace "http://openid.net/srv/ax/1.1" SHOULD be listed as an <xrd:Type>
child element of the <xrd:Service> element in the XRDS
discovery document.
</p>
<p>
To advertise the attribute types
supported, the Provider SHOULD list the attribute Type
URL as an <xrd:Type> child element of the
<xrd:Service> element in the XRDS discovery document.
</p>
<a name="fetch"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.5"></a><h3>5.
Fetch Message</h3>
<p>
The fetch message is used to retrieve personal identity
attributes from an OpenID Provider.
</p>
<a name="fetch_request"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.5.1"></a><h3>5.1.
Fetch Request Format</h3>
<p>
With the exception of "openid.ax.mode", all of the following
request fields are OPTIONAL, though at least one of
"openid.ax.required" or "openid.ax.if_available" MUST be
specified in the request, and any attribute alias present in a
"openid.ax.required" or "openid.ax.if_available" parameter MUST
have an associated "openid.ax.type.<alias>" parameter.
The supported length for attribute aliases MUST be at least
32 characters.
</p>
<p>
Multiple attribute aliases in the "openid.ax.required" and
"openid.ax.if_available" directives are separated with a
comma, ",".
</p>
<p>
</p>
<blockquote class="text"><dl>
<dt>openid.ax.mode</dt>
<dd>
<blockquote class="text">
<p>
REQUIRED. Value: "fetch_request".
</p>
</blockquote>
</dd>
<dt>openid.ax.type.<alias></dt>
<dd>
<blockquote class="text">
<p>
The value of this parameter specifies the type identifier
URI of a requested attribute. The <alias> will
further be used to identify the attribute being exchanged.
</p>
<p>
Attribute aliases MUST NOT contain newline and colon characters,
as specified in the Data Formats / Protocol Messages section of
<a class='info' href='#OpenID.authentication-2.0'>[OpenID.authentication‑2.0]<span> (</span><span class='info'>specs@openid.net, “OpenID Authentication 2.0 - Final,” August 2007.</span><span>)</span></a>; they also MUST
NOT contain commas (",") and periods (".").
</p>
</blockquote>
</dd>
<dt>openid.ax.required</dt>
<dd>
<blockquote class="text">
<p>
Value: an attribute alias, or a list of aliases
corresponding to the URIs defined by
"openid.ax.type.<alias>" parameters. Multiple
attribute aliases are separated with a comma, ",".
</p>
<p>
By requesting attributes using this field, a hint is sent
to the OP about the RP's requirements for offering certain
functionality and should be used by the OP to help the
user decide what attributes to release. RP's requirements
should not be enforced by the OP.
</p>
<p>
The RP should offer, out of band of attribute exchange,
an alternate method of collecting the attributes it needs,
if they weren't obtained via attribute exchange.
</p>
</blockquote>
</dd>
<dt>openid.ax.if_available</dt>
<dd>
<blockquote class="text">
<p>
Value: an attribute alias, or a list of aliases
corresponding to the URIs defined by
"openid.ax.type.<alias>" parameters. Multiple
attribute aliases are separated with a comma, ",".
</p>
<p>
Attributes requested using this field are deemed
optional by the RP; the RP should be able to complete
the interaction with the user even if values are not
provided by the OP for the optional attributes.
</p>
</blockquote>
</dd>
<dt>openid.ax.count.<alias></dt>
<dd>
<blockquote class="text">
<p>
The number of values for the specified attribute
alias the Relying Party wishes to receive from the OpenID
Provider. If present, the value MUST be greater than zero,
or the special value "unlimited" which signifies that the
RP is requesting as many values as the OP has for the
attribute. If absent, exactly one value is requested.
</p>
<p>
OpenID Providers MAY return less than or the exact
number of values speficied by this field for the
associated attribute, but MUST NOT return more than
the number of requested values for the attribute.
</p>
</blockquote>
</dd>
<dt>openid.ax.value.<alias>.<number></dt>
<dd>
<blockquote class="text">
<p>
Assigns a value to the attribute referred to as
<alias>. The <number> uniquely identifies the
index of the value, ranging from one to the value specified
by "openid.ax.count.<alias>". This parameter format
MUST be used if "openid.ax.count.<alias>" is sent,
and the number of these parameters MUST be equal to the
value specified by "openid.ax.count.<alias>".
</p>
</blockquote>
</dd>
<dt>openid.ax.update_url</dt>
<dd>
<blockquote class="text">
<p>
If present, the OpenID Provider may re-post the fetch
response message to the specified URL at some time
after the initial response has been sent, using a
OpenID Authentication Positive Assertion. If the
OpenID Provider supports this feature it MUST return
the parameter as part of the fetch response message.
If it does not support this feature it may legally
ignore this parameter.
</p>
<p>
The value of the "openid.ax.update_url" field MUST
be used as value for "openid.return_to" field of the
underlying OpenID Authentication Positive Assertion
of the fetch response update.
</p>
<p>
The "openid.ax.update_url" value MUST also match the
realm specified in the underlying OpenID message of the
fetch request, if a "openid.realm" field is present.
The matching rules are the ones specified in the
"Realms" section of the OpenID Authentication protocol.
</p>
<p>
This "unsolicited" response message would be
generated in response to an attribute information
update, and would contain the updated data. The OP
should obtain the user's consent for resending the
updated data to the RPs, as with any OpenID Positive
Assertion.
</p>
<p>
The relying party may include transaction data encoded
in the URL such that it contains enough information to
match the attribute information to the identity subject.
Additional information may be encoded in the URL by the
relying party as necessary.
</p>
<p>
If an RP wishes to receive no further updates for an
attribute, it MAY return the HTTP 404 response code to
the corresponding "update_url". OPs MAY decide to
stop sending updates after encountering 404 response
codes.
</p>
</blockquote>
</dd>
</dl></blockquote><p>
</p>
<p>
This example requests the required full name and gender
information, and the optional favourite dog and movie
information. The Relying Party is interested in up to three
favorite movies associated with the subject identifier.
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
openid.ns.ax=http://openid.net/srv/ax/1.1
openid.ax.mode=fetch_request
openid.ax.type.fname=http://example.com/schema/fullname
openid.ax.type.gender=http://example.com/schema/gender
openid.ax.type.fav_dog=http://example.com/schema/favourite_dog
openid.ax.type.fav_movie=http://example.com/schema/favourite_movie
openid.ax.count.fav_movie=3
openid.ax.required=fname,gender
openid.ax.if_available=fav_dog,fav_movie
openid.ax.update_url=http://idconsumer.com/update?transaction_id=a6b5c41
</pre></div>
<a name="fetch_response"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.5.2"></a><h3>5.2.
Fetch Response Format</h3>
<p>
The fetch response message supplies the information
requested in the fetch request. Each attribute is supplied
with the assigned alias prefixed by "openid.ax.value." as the
lvalue and the attribute value as the rvalue. Attribute
types are also returned in the "openid.ax.type.<alias>"
parameters. The supported length for attribute aliases MUST
be at least 32 characters.
</p>
<p>
With the exception of "openid.ax.mode", all of the following
request fields are OPTIONAL, though any attribute value
present in a "openid.ax.value.<alias>" parameter MUST
have an associated "openid.ax.type.<alias>" parameter.
</p>
<p>
If a value was not supplied or available from the user,
the associated "openid.ax.value.<alias>" field
SHOULD NOT be included by the OP in the fetch response.
An "openid.ax.count.<alias>" with a value of "0"
together with its corresponding "openid.ax.type.<alias>"
field MAY be included to explicitly state that no values
are provided for an attribute.
</p>
<p>
Validation of the received data should be performed out of band
of attribute exchange by the RP.
</p>
<p>
</p>
<blockquote class="text"><dl>
<dt>openid.ax.mode</dt>
<dd>
<blockquote class="text">
<p>
REQUIRED. Value: "fetch_response".
</p>
</blockquote>
</dd>
<dt>openid.ax.type.<alias></dt>
<dd>
<blockquote class="text">
<p>
The value of this parameter specifies the type identifier
URI for an attribute in the fetch response.
The <alias> will further be used to identify
the attribute being exchanged.
</p>
<p>
Attribute aliases MUST NOT contain newline and colon characters,
as specified in the Data Formats / Protocol Messages section of
<a class='info' href='#OpenID.authentication-2.0'>[OpenID.authentication‑2.0]<span> (</span><span class='info'>specs@openid.net, “OpenID Authentication 2.0 - Final,” August 2007.</span><span>)</span></a>; they also MUST
NOT contain commas (",") and periods (".").
</p>
</blockquote>
</dd>
<dt>openid.ax.count.<alias></dt>
<dd>
<blockquote class="text">
<p>
The number of values returned for the attribute referred
to as <alias>.
</p>
</blockquote>
</dd>
<dt>openid.ax.value.<alias></dt>
<dd>
<blockquote class="text">
<p>
Assigns a value to the attribute referred to as
<alias>. This parameter format MUST be used if
"openid.ax.count.<alias>" is not sent.
</p>
</blockquote>
</dd>
<dt>openid.ax.value.<alias>.<number></dt>
<dd>
<blockquote class="text">
<p>
Assigns a value to the attribute referred to as
<alias>. This parameter format MUST be used
if "openid.ax.count.<alias>" is sent and at least
one value is provided for the associated attribute.
</p>
<p>
The <number> uniquely identifies the index of
the value, ranging from one to the value specified by
"openid.ax.count.<alias>". The number of
parameters MUST be equal to the value specified by
"openid.ax.count.<alias>". The OP is not
required to preserve the order of attribute values
among fetch responses.
</p>
</blockquote>
</dd>
<dt>openid.ax.update_url</dt>
<dd>
<blockquote class="text">
<p>
Returns the "update_url" parameter specified in the
request. If the OpenID Provider receives an
"update_url" parameter and it intends to support the
attribute update feature, it MUST present the
"update_url" parameter and value as part of the fetch
response message.
</p>
</blockquote>
</dd>
</dl></blockquote><p>
</p>
<p>
A fetch response message may also be sent to the
"update_url" specified in <a class='info' href='#fetch_request'>Section 5.1<span> (</span><span class='info'>Fetch Request Format</span><span>)</span></a> in response to attribute value
updates on the OpenID Provider.
</p>
<p>
The response to the previous request example, in which the
required full name information, and the optional favourite
dog information are supplied. Even though three movie names
were requested, the OP supplied only two values.
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
openid.ns.ax=http://openid.net/srv/ax/1.1
openid.ax.mode=fetch_response
openid.ax.type.fname=http://example.com/schema/fullname
openid.ax.type.gender=http://example.com/schema/gender
openid.ax.type.fav_dog=http://example.com/schema/favourite_dog
openid.ax.type.fav_movie=http://example.com/schema/favourite_movie
openid.ax.value.fname=John Smith
openid.ax.count.gender=0
openid.ax.value.fav_dog=Spot
openid.ax.count.fav_movie=2
openid.ax.value.fav_movie.1=Movie1
openid.ax.value.fav_movie.2=Movie2
openid.ax.update_url=http://idconsumer.com/update?transaction_id=a6b5c41
</pre></div>
<a name="store"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.6"></a><h3>6.
Store Message</h3>
<p>
The store message is used to store personal identity
information to the OpenID Provider; it provides the means
for an RP to transfer to the OP attributes that the user
may consider useful, such as by providing them to other RPs.
The supported length for attribute aliases MUST be at least
32 characters.
</p>
<p>
The manner in which the OP processes the attribute payload in a
store request if out of scope of this document.
</p>
<a name="store_request"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.6.1"></a><h3>6.1.
Store Request Format</h3>
<p>
With the exception of "openid.ax.mode", all of the following
request fields are OPTIONAL. Any alias referred to in a
"openid.ax.value.<alias>" or
"openid.ax.value.<alias>.<number>" parameter MUST
have an associated "openid.ax.type.<alias>" parameter.
</p>
<p>
</p>
<blockquote class="text"><dl>
<dt>openid.ax.mode</dt>
<dd>
<blockquote class="text">
<p>
REQUIRED. Value: "store_request".
</p>
</blockquote>
</dd>
<dt>openid.ax.type.<alias></dt>
<dd>
<blockquote class="text">
<p>
The value of this parameter specifies the type identifier
URI for an attribute in the sore request.
The <alias> will further be used to identify
the attribute being exchanged.
</p>
<p>
Attribute aliases MUST NOT contain newline and colon characters,
as specified in the Data Formats / Protocol Messages section of
<a class='info' href='#OpenID.authentication-2.0'>[OpenID.authentication‑2.0]<span> (</span><span class='info'>specs@openid.net, “OpenID Authentication 2.0 - Final,” August 2007.</span><span>)</span></a>; they also MUST
NOT contain commas (",") and periods (".").
</p>
</blockquote>
</dd>
<dt>openid.ax.count.<alias></dt>
<dd>
<blockquote class="text">
<p>
The number of values sent for the attribute referred to
as <alias>. If present, it MUST be greater than
zero.
</p>
</blockquote>
</dd>
<dt>openid.ax.value.<alias></dt>
<dd>
<blockquote class="text">
<p>
Assigns a value to the attribute referred to as
<alias>. This parameter format MUST be used if
"openid.ax.count.<alias>" is not sent.
</p>
</blockquote>
</dd>
<dt>openid.ax.value.<alias>.<number></dt>
<dd>
<blockquote class="text">
<p>
Assigns a value to the attribute referred to as
<alias>. The <number> uniquely identifies the
index of the value, ranging from one to the value specified
by "openid.ax.count.<alias>". This parameter format
MUST be used if "openid.ax.count.<alias>" is sent,
and the number of these parameters MUST be equal to the
value specified by "openid.ax.count.<alias>".
</p>
</blockquote>
</dd>
</dl></blockquote><p>
</p>
<p>
</p><div style='display: table; width: 0; margin-left: 3em; margin-right: auto'><pre>
openid.ns.ax=http://openid.net/srv/ax/1.1
openid.ax.mode=store_request
openid.ax.type.fname=http://example.com/schema/fullname
openid.ax.value.fname=Bob Smith
openid.ax.type.fav_movie=http://example.com/schema/favourite_movie
openid.ax.count.fav_movie=2
openid.ax.value.fav_movie.1=Movie1
openid.ax.value.fav_movie.2=Movie2
</pre></div>
<a name="store_response"></a><br /><hr />
<table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc"> TOC </a></td></tr></table>
<a name="rfc.section.6.2"></a><h3>6.2.
Store Response Format</h3>