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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
|
<pre>Internet Engineering Task Force (IETF) P. Jones
Request for Comments: 7033 G. Salgueiro
Category: Standards Track Cisco Systems
ISSN: 2070-1721 M. Jones
Microsoft
J. Smarr
Google
September 2013
<span class="h1">WebFinger</span>
Abstract
This specification defines the WebFinger protocol, which can be used
to discover information about people or other entities on the
Internet using standard HTTP methods. WebFinger discovers
information for a URI that might not be usable as a locator
otherwise, such as account or email URIs.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc7033">http://www.rfc-editor.org/info/rfc7033</a>.
Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Jones, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-3">3</a>
<a href="#section-2">2</a>. Terminology .....................................................<a href="#page-3">3</a>
<a href="#section-3">3</a>. Example Uses of WebFinger .......................................<a href="#page-4">4</a>
<a href="#section-3.1">3.1</a>. Identity Provider Discovery for OpenID Connect .............<a href="#page-4">4</a>
<a href="#section-3.2">3.2</a>. Getting Author and Copyright Information for a Web Page ....<a href="#page-5">5</a>
<a href="#section-4">4</a>. WebFinger Protocol ..............................................<a href="#page-7">7</a>
<a href="#section-4.1">4.1</a>. Constructing the Query Component of the Request URI.......<a href="#page-7">7</a>
<a href="#section-4.2">4.2</a>. Performing a WebFinger Query..............................<a href="#page-8">8</a>
<a href="#section-4.3">4.3</a>. The "rel" Parameter.......................................<a href="#page-9">9</a>
<a href="#section-4.4">4.4</a>. The JSON Resource Descriptor (JRD).......................<a href="#page-11">11</a>
<a href="#section-4.4.1">4.4.1</a>. subject.............................................<a href="#page-11">11</a>
<a href="#section-4.4.2">4.4.2</a>. aliases.............................................<a href="#page-11">11</a>
<a href="#section-4.4.3">4.4.3</a>. properties..........................................<a href="#page-12">12</a>
<a href="#section-4.4.4">4.4.4</a>. links...............................................<a href="#page-12">12</a>
<a href="#section-4.5">4.5</a>. WebFinger and URIs.......................................<a href="#page-14">14</a>
<a href="#section-5">5</a>. Cross-Origin Resource Sharing (CORS) ...........................<a href="#page-14">14</a>
<a href="#section-6">6</a>. Access Control .................................................<a href="#page-15">15</a>
<a href="#section-7">7</a>. Hosted WebFinger Services ......................................<a href="#page-15">15</a>
<a href="#section-8">8</a>. Definition of WebFinger Applications ...........................<a href="#page-16">16</a>
<a href="#section-8.1">8.1</a>. Specification of the URI Scheme and URI ...................<a href="#page-17">17</a>
<a href="#section-8.2">8.2</a>. Host Resolution ...........................................<a href="#page-17">17</a>
<a href="#section-8.3">8.3</a>. Specification of Properties ...............................<a href="#page-17">17</a>
<a href="#section-8.4">8.4</a>. Specification of Links ....................................<a href="#page-18">18</a>
<a href="#section-8.5">8.5</a>. One URI, Multiple Applications ............................<a href="#page-18">18</a>
<a href="#section-8.6">8.6</a>. Registration of Link Relation Types and Properties ........<a href="#page-19">19</a>
<a href="#section-9">9</a>. Security Considerations ........................................<a href="#page-19">19</a>
<a href="#section-9.1">9.1</a>. Transport-Related Issues ..................................<a href="#page-19">19</a>
<a href="#section-9.2">9.2</a>. User Privacy Considerations ...............................<a href="#page-19">19</a>
<a href="#section-9.3">9.3</a>. Abuse Potential ...........................................<a href="#page-21">21</a>
<a href="#section-9.4">9.4</a>. Information Reliability ...................................<a href="#page-21">21</a>
<a href="#section-10">10</a>. IANA Considerations ...........................................<a href="#page-22">22</a>
<a href="#section-10.1">10.1</a>. Well-Known URI ...........................................<a href="#page-22">22</a>
<a href="#section-10.2">10.2</a>. JSON Resource Descriptor (JRD) Media Type ................<a href="#page-22">22</a>
<a href="#section-10.3">10.3</a>. Registering Link Relation Types ..........................<a href="#page-24">24</a>
<a href="#section-10.4">10.4</a>. Establishment of the "WebFinger Properties" Registry .....<a href="#page-24">24</a>
<a href="#section-10.4.1">10.4.1</a>. The Registration Template .........................<a href="#page-24">24</a>
<a href="#section-10.4.2">10.4.2</a>. The Registration Procedures .......................<a href="#page-25">25</a>
<a href="#section-11">11</a>. Acknowledgments ...............................................<a href="#page-26">26</a>
<a href="#section-12">12</a>. References ....................................................<a href="#page-26">26</a>
<a href="#section-12.1">12.1</a>. Normative References .....................................<a href="#page-26">26</a>
<a href="#section-12.2">12.2</a>. Informative References ...................................<a href="#page-27">27</a>
<span class="grey">Jones, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
WebFinger is used to discover information about people or other
entities on the Internet that are identified by a URI [<a href="#ref-6" title=""Uniform Resource Identifier (URI): Generic Syntax"">6</a>] using
standard Hypertext Transfer Protocol (HTTP) [<a href="#ref-2" title=""Hypertext Transfer Protocol -- HTTP/1.1"">2</a>] methods over a secure
transport [<a href="#ref-12" title=""HTTP Over TLS"">12</a>]. A WebFinger resource returns a JavaScript Object
Notation (JSON) [<a href="#ref-5" title=""The application/json Media Type for JavaScript Object Notation (JSON)"">5</a>] object describing the entity that is queried.
The JSON object is referred to as the JSON Resource Descriptor (JRD).
For a person, the type of information that might be discoverable via
WebFinger includes a personal profile address, identity service,
telephone number, or preferred avatar. For other entities on the
Internet, a WebFinger resource might return JRDs containing link
relations [<a href="#ref-8" title=""Link Relations"">8</a>] that enable a client to discover, for example, that a
printer can print in color on A4 paper, the physical location of a
server, or other static information.
Information returned via WebFinger might be for direct human
consumption (e.g., looking up someone's phone number), or it might be
used by systems to help carry out some operation (e.g., facilitating,
with additional security mechanisms, logging into a web site by
determining a user's identity service). The information is intended
to be static in nature, and, as such, WebFinger is not intended to be
used to return dynamic information like the temperature of a CPU or
the current toner level in a laser printer.
The WebFinger protocol is designed to be used across many
applications. Applications that wish to utilize WebFinger will need
to specify properties, titles, and link relation types that are
appropriate for the application. Further, applications will need to
define the appropriate URI scheme to utilize for the query target.
Use of WebFinger is illustrated in the examples in <a href="#section-3">Section 3</a> and
described more formally in <a href="#section-4">Section 4</a>. <a href="#section-8">Section 8</a> describes how
applications of WebFinger may be defined.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Terminology</span>
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 href="./rfc2119">RFC 2119</a> [<a href="#ref-1" title=""Key words for use in RFCs to Indicate Requirement Levels"">1</a>].
WebFinger makes heavy use of "link relations". A link relation is an
attribute-value pair in which the attribute identifies the type of
relationship between the linked entity or resource and the
information specified in the value. In Web Linking [<a href="#ref-4" title=""Web Linking"">4</a>], the link
relation is represented using an HTTP entity-header of "Link", where
the "rel" attribute specifies the type of relationship and the "href"
<span class="grey">Jones, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
attribute specifies the information that is linked to the entity or
resource. In WebFinger, the same concept is represented using a JSON
array of "links" objects, where each member named "rel" specifies the
type of relationship and each member named "href" specifies the
information that is linked to the entity or resource. Note that
WebFinger narrows the scope of a link relation beyond what is defined
for Web Linking by stipulating that the value of the "rel" member
needs to be either a single IANA-registered link relation type [<a href="#ref-8" title=""Link Relations"">8</a>] or
a URI [<a href="#ref-6" title=""Uniform Resource Identifier (URI): Generic Syntax"">6</a>].
The use of URIs throughout this document refers to URIs following the
syntax specified in <a href="./rfc3986#section-3">Section 3 of RFC 3986</a> [<a href="#ref-6" title=""Uniform Resource Identifier (URI): Generic Syntax"">6</a>]. Relative URIs, having
syntax following that of <a href="./rfc3986#section-4.2">Section 4.2 of RFC 3986</a>, are not used with
WebFinger.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Example Uses of WebFinger</span>
This section shows a few sample uses of WebFinger. Any application
of WebFinger would be specified outside of this document, as
described in <a href="#section-8">Section 8</a>. The examples in this section should be
simple enough to understand without having seen the formal
specifications of the applications.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Identity Provider Discovery for OpenID Connect</span>
Suppose Carol wishes to authenticate with a web site she visits using
OpenID Connect [<a href="#ref-15" title=""OpenID Connect Messages 1.0"">15</a>]. She would provide the web site with her OpenID
Connect identifier, say carol@example.com. The visited web site
would perform a WebFinger query looking for the OpenID Connect
provider. Since the site is interested in only one particular link
relation, the WebFinger resource might utilize the "rel" parameter as
described in <a href="#section-4.3">Section 4.3</a>:
GET /.well-known/webfinger?
resource=acct%3Acarol%40example.com&
rel=http%3A%2F%2Fopenid.net%2Fspecs%2Fconnect%2F1.0%2Fissuer
HTTP/1.1
Host: example.com
<span class="grey">Jones, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
The server might respond like this:
HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/jrd+json
{
"subject" : "acct:carol@example.com",
"links" :
[
{
"rel" : "<a href="http://openid.net/specs/connect/1.0/issuer">http://openid.net/specs/connect/1.0/issuer</a>",
"href" : "https://openid.example.com"
}
]
}
Since the "rel" parameter only serves to filter the link relations
returned by the resource, other name/value pairs in the response,
including any aliases or properties, would be returned. Also, since
support for the "rel" parameter is not guaranteed, the client must
not assume the "links" array will contain only the requested link
relation.
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Getting Author and Copyright Information for a Web Page</span>
Suppose an application is defined to retrieve metadata information
about a web page URL, such as author and copyright information. To
retrieve that information, the client can utilize WebFinger to issue
a query for the specific URL. Suppose the URL of interest is
http://blog.example.com/article/id/314. The client would issue a
query similar to the following:
GET /.well-known/webfinger?
resource=http%3A%2F%2Fblog.example.com%2Farticle%2Fid%2F314
HTTP/1.1
Host: blog.example.com
<span class="grey">Jones, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
The server might then reply in this way:
HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/jrd+json
{
"subject" : "http://blog.example.com/article/id/314",
"aliases" :
[
"http://blog.example.com/cool_new_thing",
"http://blog.example.com/steve/article/7"
],
"properties" :
{
"http://blgx.example.net/ns/version" : "1.3",
"http://blgx.example.net/ns/ext" : null
},
"links" :
[
{
"rel" : "copyright",
"href" : "http://www.example.com/copyright"
},
{
"rel" : "author",
"href" : "http://blog.example.com/author/steve",
"titles" :
{
"en-us" : "The Magical World of Steve",
"fr" : "Le Monde Magique de Steve"
},
"properties" :
{
"http://example.com/role" : "editor"
}
}
]
}
In the above example, we see that the server returned a list of
aliases, properties, and links related to the subject URL. The links
contain references to information for each link relation type. For
the author link, the server provided a reference to the author's
blog, along with a title for the blog in two languages. The server
also returned a single property related to the author, indicating the
author's role as editor of the blog.
<span class="grey">Jones, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
It is worth noting that, while the server returned just two links in
the "links" array in this example, a server might return any number
of links when queried.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. WebFinger Protocol</span>
The WebFinger protocol is used to request information about an entity
identified by a query target (a URI). The client can optionally
specify one or more link relation types for which it would like to
receive information.
A WebFinger request is an HTTPS request to a WebFinger resource. A
WebFinger resource is a well-known URI [<a href="#ref-3" title=""Defining Well-Known Uniform Resource Identifiers (URIs)"">3</a>] using the HTTPS scheme
constructed along with the required query target and optional link
relation types. WebFinger resources MUST NOT be served with any
other URI scheme (such as HTTP).
A WebFinger resource is always given a query target, which is another
URI that identifies the entity whose information is sought. GET
requests to a WebFinger resource convey the query target in the
"resource" parameter of the WebFinger URI's query string; see <a href="#section-4.1">Section</a>
<a href="#section-4.1">4.1</a> for details.
The host to which a WebFinger query is issued is significant. If the
query target contains a "host" portion (<a href="./rfc3986#section-3.2.2">Section 3.2.2 of RFC 3986</a>),
then the host to which the WebFinger query is issued SHOULD be the
same as the "host" portion of the query target, unless the client
receives instructions through some out-of-band mechanism to send the
query to another host. If the query target does not contain a "host"
portion, then the client chooses a host to which it directs the query
using additional information it has.
The path component of a WebFinger URI MUST be the well-known path
"/.well-known/webfinger". A WebFinger URI MUST contain a query
component that encodes the query target and optional link relation
types as specified in <a href="#section-4.1">Section 4.1</a>.
The WebFinger resource returns a JSON Resource Descriptor (JRD) as
the resource representation to convey information about an entity on
the Internet. Also, the Cross-Origin Resource Sharing (CORS) [<a href="#ref-7" title=""Cross-Origin Resource Sharing"">7</a>]
specification is utilized to facilitate queries made via a web
browser.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Constructing the Query Component of the Request URI</span>
A WebFinger URI MUST contain a query component (see <a href="./rfc3986#section-3.4">Section 3.4 of
RFC 3986</a>). The query component MUST contain a "resource" parameter
and MAY contain one or more "rel" parameters. The "resource"
<span class="grey">Jones, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
parameter MUST contain the query target (URI), and the "rel"
parameters MUST contain encoded link relation types according to the
encoding described in this section.
To construct the query component, the client performs the following
steps. First, each parameter value is percent-encoded, as per
<a href="./rfc3986#section-2.1">Section 2.1 of RFC 3986</a>. The encoding is done to conform to the
query production in <a href="#section-3.4">Section 3.4</a> of that specification, with the
addition that any instances of the "=" and "&" characters within the
parameter values are also percent-encoded. Next, the client
constructs a string to be placed in the query component by
concatenating the name of the first parameter together with an equal
sign ("=") and the percent-encoded parameter value. For any
subsequent parameters, the client appends an ampersand ("&") to the
string, the name of the next parameter, an equal sign, and the
parameter value. The client MUST NOT insert any spaces while
constructing the string. The order in which the client places each
attribute-value pair within the query component does not matter in
the interpretation of the query component.
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Performing a WebFinger Query</span>
A WebFinger client issues a query using the GET method to the well-
known [<a href="#ref-3" title=""Defining Well-Known Uniform Resource Identifiers (URIs)"">3</a>] resource identified by the URI whose path component is
"/.well-known/webfinger" and whose query component MUST include the
"resource" parameter exactly once and set to the value of the URI for
which information is being sought.
If the "resource" parameter is absent or malformed, the WebFinger
resource MUST indicate that the request is bad as per <a href="./rfc2616#section-10.4.1">Section 10.4.1
of RFC 2616</a> [<a href="#ref-2" title=""Hypertext Transfer Protocol -- HTTP/1.1"">2</a>].
If the "resource" parameter is a value for which the server has no
information, the server MUST indicate that it was unable to match the
request as per <a href="./rfc2616#section-10.4.5">Section 10.4.5 of RFC 2616</a>.
A client MUST query the WebFinger resource using HTTPS only. If the
client determines that the resource has an invalid certificate, the
resource returns a 4xx or 5xx status code, or if the HTTPS connection
cannot be established for any reason, then the client MUST accept
that the WebFinger query has failed and MUST NOT attempt to reissue
the WebFinger request using HTTP over a non-secure connection.
A WebFinger resource MUST return a JRD as the representation for the
resource if the client requests no other supported format explicitly
via the HTTP "Accept" header. The client MAY include the "Accept"
header to indicate a desired representation; representations other
than JRD might be defined in future specifications. The WebFinger
<span class="grey">Jones, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
resource MUST silently ignore any requested representations that it
does not understand or support. The media type used for the JSON
Resource Descriptor (JRD) is "application/jrd+json" (see <a href="#section-10.2">Section</a>
<a href="#section-10.2">10.2</a>).
The properties, titles, and link relation types returned by the
server in a JRD might be varied and numerous. For example, the
server might return information about a person's blog, vCard [<a href="#ref-14" title=""vCard Format Specification"">14</a>],
avatar, OpenID Connect provider, RSS or ATOM feed, and so forth in a
reply. Likewise, if a server has no information to provide, it might
return a JRD with an empty "links" array or no "links" array.
A WebFinger resource MAY redirect the client; if it does, the
redirection MUST only be to an "https" URI and the client MUST
perform certificate validation again when redirected.
A WebFinger resource can include cache validators in a response to
enable conditional requests by the client and/or expiration times as
per <a href="./rfc2616#section-13">Section 13 of RFC 2616</a>.
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. The "rel" Parameter</span>
When issuing a request to a WebFinger resource, the client MAY
utilize the "rel" parameter to request only a subset of the
information that would otherwise be returned without the "rel"
parameter. When the "rel" parameter is used and accepted, only the
link relation types that match the link relation type provided via
the "rel" parameter are included in the array of links returned in
the JRD. If there are no matching link relation types defined for
the resource, the "links" array in the JRD will be either absent or
empty. All other information present in a resource descriptor
remains present, even when "rel" is employed.
The "rel" parameter MAY be included multiple times in order to
request multiple link relation types.
The purpose of the "rel" parameter is to return a subset of "link
relation objects" (see <a href="#section-4.4.4">Section 4.4.4</a>) that would otherwise be
returned in the resource descriptor. Use of the parameter might
reduce processing requirements on either the client or server, and it
might also reduce the bandwidth required to convey the partial
resource descriptor, especially if there are numerous link relation
values to convey for a given "resource" value. Note that if a client
requests a particular link relation type for which the server has no
information, the server MAY return a JRD with an empty "links" array
or no "links" array.
<span class="grey">Jones, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
WebFinger resources SHOULD support the "rel" parameter. If the
resource does not support the "rel" parameter, it MUST ignore the
parameter and process the request as if no "rel" parameter values
were present.
The following example uses the "rel" parameter to request links for
two link relation types:
GET /.well-known/webfinger?
resource=acct%3Abob%40example.com&
rel=http%3A%2F%2Fwebfinger.example%2Frel%2Fprofile-page&
rel=http%3A%2F%2Fwebfinger.example%2Frel%2Fbusinesscard HTTP/1.1
Host: example.com
In this example, the client requests the link relations of type
"http://webfinger.example/rel/profile-page" and
"http://webfinger.example/rel/businesscard". The server then
responds with a message like this:
HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/jrd+json
{
"subject" : "acct:bob@example.com",
"aliases" :
[
"https://www.example.com/~bob/"
],
"properties" :
{
"http://example.com/ns/role" : "employee"
},
"links" :
[
{
"rel" : "http://webfinger.example/rel/profile-page",
"href" : "https://www.example.com/~bob/"
},
{
"rel" : "http://webfinger.example/rel/businesscard",
"href" : "https://www.example.com/~bob/bob.vcf"
}
]
}
<span class="grey">Jones, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
As you can see in the response, the resource representation contains
only the links of the types requested by the client and for which the
server had information, but the other parts of the JRD are still
present. Note also in the above example that the links returned in
the "links" array all use HTTPS, which is important if the data
indirectly obtained via WebFinger needs to be returned securely.
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. The JSON Resource Descriptor (JRD)</span>
The JSON Resource Descriptor (JRD), originally introduced in <a href="./rfc6415">RFC 6415</a>
[<a href="#ref-16" title=""Web Host Metadata"">16</a>] and based on the Extensible Resource Descriptor (XRD) format
[<a href="#ref-17" title=""Extensible Resource Descriptor (XRD) Version 1.0"">17</a>], is a JSON object that comprises the following name/value pairs:
o subject
o aliases
o properties
o links
The member "subject" is a name/value pair whose value is a string,
"aliases" is an array of strings, "properties" is an object
comprising name/value pairs whose values are strings, and "links" is
an array of objects that contain link relation information.
When processing a JRD, the client MUST ignore any unknown member and
not treat the presence of an unknown member as an error.
Below, each of these members of the JRD is described in more detail.
<span class="h4"><a class="selflink" id="section-4.4.1" href="#section-4.4.1">4.4.1</a>. subject</span>
The value of the "subject" member is a URI that identifies the entity
that the JRD describes.
The "subject" value returned by a WebFinger resource MAY differ from
the value of the "resource" parameter used in the client's request.
This might happen, for example, when the subject's identity changes
(e.g., a user moves his or her account to another service) or when
the resource prefers to express URIs in canonical form.
The "subject" member SHOULD be present in the JRD.
<span class="h4"><a class="selflink" id="section-4.4.2" href="#section-4.4.2">4.4.2</a>. aliases</span>
The "aliases" array is an array of zero or more URI strings that
identify the same entity as the "subject" URI.
The "aliases" array is OPTIONAL in the JRD.
<span class="grey">Jones, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
<span class="h4"><a class="selflink" id="section-4.4.3" href="#section-4.4.3">4.4.3</a>. properties</span>
The "properties" object comprises zero or more name/value pairs whose
names are URIs (referred to as "property identifiers") and whose
values are strings or null. Properties are used to convey additional
information about the subject of the JRD. As an example, consider
this use of "properties":
"properties" : { "http://webfinger.example/ns/name" : "Bob Smith" }
The "properties" member is OPTIONAL in the JRD.
<span class="h4"><a class="selflink" id="section-4.4.4" href="#section-4.4.4">4.4.4</a>. links</span>
The "links" array has any number of member objects, each of which
represents a link [<a href="#ref-4" title=""Web Linking"">4</a>]. Each of these link objects can have the
following members:
o rel
o type
o href
o titles
o properties
The "rel" and "href" members are strings representing the link's
relation type and the target URI, respectively. The context of the
link is the "subject" (see <a href="#section-4.4.1">Section 4.4.1</a>).
The "type" member is a string indicating what the media type of the
result of dereferencing the link ought to be.
The order of elements in the "links" array MAY be interpreted as
indicating an order of preference. Thus, if there are two or more
link relations having the same "rel" value, the first link relation
would indicate the user's preferred link.
The "links" array is OPTIONAL in the JRD.
Below, each of the members of the objects found in the "links" array
is described in more detail. Each object in the "links" array,
referred to as a "link relation object", is completely independent
from any other object in the array; any requirement to include a
given member in the link relation object refers only to that
particular object.
<span class="grey">Jones, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
<span class="h5"><a class="selflink" id="section-4.4.4.1" href="#section-4.4.4.1">4.4.4.1</a>. rel</span>
The value of the "rel" member is a string that is either a URI or a
registered relation type [<a href="#ref-8" title=""Link Relations"">8</a>] (see <a href="./rfc5988">RFC 5988</a> [<a href="#ref-4" title=""Web Linking"">4</a>]). The value of the
"rel" member MUST contain exactly one URI or registered relation
type. The URI or registered relation type identifies the type of the
link relation.
The other members of the object have meaning only once the type of
link relation is understood. In some instances, the link relation
will have associated semantics enabling the client to query for other
resources on the Internet. In other instances, the link relation
will have associated semantics enabling the client to utilize the
other members of the link relation object without fetching additional
external resources.
URI link relation type values are compared using the "Simple String
Comparison" algorithm of <a href="./rfc3986#section-6.2.1">Section 6.2.1 of RFC 3986</a>.
The "rel" member MUST be present in the link relation object.
<span class="h5"><a class="selflink" id="section-4.4.4.2" href="#section-4.4.4.2">4.4.4.2</a>. type</span>
The value of the "type" member is a string that indicates the media
type [<a href="#ref-9" title=""MIME Media Types"">9</a>] of the target resource (see <a href="./rfc6838">RFC 6838</a> [<a href="#ref-10" title=""Media Type Specifications and Registration Procedures"">10</a>]).
The "type" member is OPTIONAL in the link relation object.
<span class="h5"><a class="selflink" id="section-4.4.4.3" href="#section-4.4.4.3">4.4.4.3</a>. href</span>
The value of the "href" member is a string that contains a URI
pointing to the target resource.
The "href" member is OPTIONAL in the link relation object.
<span class="h5"><a class="selflink" id="section-4.4.4.4" href="#section-4.4.4.4">4.4.4.4</a>. titles</span>
The "titles" object comprises zero or more name/value pairs whose
names are a language tag [<a href="#ref-11" title=""Tags for Identifying Languages"">11</a>] or the string "und". The string is
human-readable and describes the link relation. More than one title
for the link relation MAY be provided for the benefit of users who
utilize the link relation, and, if used, a language identifier SHOULD
be duly used as the name. If the language is unknown or unspecified,
then the name is "und".
A JRD SHOULD NOT include more than one title identified with the same
language tag (or "und") within the link relation object. Meaning is
undefined if a link relation object includes more than one title
<span class="grey">Jones, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
named with the same language tag (or "und"), though this MUST NOT be
treated as an error. A client MAY select whichever title or titles
it wishes to utilize.
Here is an example of the "titles" object:
"titles" :
{
"en-us" : "The Magical World of Steve",
"fr" : "Le Monde Magique de Steve"
}
The "titles" member is OPTIONAL in the link relation object.
<span class="h5"><a class="selflink" id="section-4.4.4.5" href="#section-4.4.4.5">4.4.4.5</a>. properties</span>
The "properties" object within the link relation object comprises
zero or more name/value pairs whose names are URIs (referred to as
"property identifiers") and whose values are strings or null.
Properties are used to convey additional information about the link
relation. As an example, consider this use of "properties":
"properties" : { "http://webfinger.example/mail/port" : "993" }
The "properties" member is OPTIONAL in the link relation object.
<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>. WebFinger and URIs</span>
WebFinger requests include a "resource" parameter (see <a href="#section-4.1">Section 4.1</a>)
specifying the query target (URI) for which the client requests
information. WebFinger is neutral regarding the scheme of such a
URI: it could be an "acct" URI [<a href="#ref-18" title=""The 'acct' URI Scheme"">18</a>], an "http" or "https" URI, a
"mailto" URI [<a href="#ref-19" title=""The 'mailto' URI Scheme"">19</a>], or some other scheme.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Cross-Origin Resource Sharing (CORS)</span>
WebFinger resources might not be accessible from a web browser due to
"Same-Origin" policies. The current best practice is to make
resources available to browsers through Cross-Origin Resource Sharing
(CORS) [<a href="#ref-7" title=""Cross-Origin Resource Sharing"">7</a>], and servers MUST include the Access-Control-Allow-Origin
HTTP header in responses. Servers SHOULD support the least
restrictive setting by allowing any domain access to the WebFinger
resource:
Access-Control-Allow-Origin: *
<span class="grey">Jones, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
There are cases where defaulting to the least restrictive setting is
not appropriate. For example, a server on an intranet that provides
sensitive company information SHOULD NOT allow CORS requests from any
domain, as that could allow leaking of that sensitive information. A
server that wishes to restrict access to information from external
entities SHOULD use a more restrictive Access-Control-Allow-Origin
header.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Access Control</span>
As with all web resources, access to the WebFinger resource could
require authentication. Further, failure to provide required
credentials might result in the server forbidding access or providing
a different response than had the client authenticated with the
server.
Likewise, a WebFinger resource MAY provide different responses to
different clients based on other factors, such as whether the client
is inside or outside a corporate network. As a concrete example, a
query performed on the internal corporate network might return link
relations to employee pictures, whereas link relations for employee
pictures might not be provided to external entities.
Further, link relations provided in a WebFinger resource
representation might point to web resources that impose access
restrictions. For example, the aforementioned corporate server may
provide both internal and external entities with URIs to employee
pictures, but further authentication might be required in order for
the client to access the picture resources if the request comes from
outside the corporate network.
The decisions made with respect to what set of link relations a
WebFinger resource provides to one client versus another and what
resources require further authentication, as well as the specific
authentication mechanisms employed, are outside the scope of this
document.
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Hosted WebFinger Services</span>
As with most services provided on the Internet, it is possible for a
domain owner to utilize "hosted" WebFinger services. By way of
example, a domain owner might control most aspects of their domain
but use a third-party hosting service for email. In the case of
email, mail exchange (MX) records identify mail servers for a domain.
An MX record points to the mail server to which mail for the domain
should be delivered. To the sending server, it does not matter
whether those MX records point to a server in the destination domain
or a different domain.
<span class="grey">Jones, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
Likewise, a domain owner might utilize the services of a third party
to provide WebFinger services on behalf of its users. Just as a
domain owner is required to insert MX records into DNS to allow for
hosted email services, the domain owner is required to redirect HTTP
queries to its domain to allow for hosted WebFinger services.
When a query is issued to the WebFinger resource, the web server MUST
return a response with a redirection status code that includes a
Location header pointing to the location of the hosted WebFinger
service URI. This WebFinger service URI does not need to point to
the well-known WebFinger location on the hosting service provider
server.
As an example, assume that example.com's WebFinger services are
hosted by wf.example.net. Suppose a client issues a query for
acct:alice@example.com like this:
GET /.well-known/webfinger?
resource=acct%3Aalice%40example.com HTTP/1.1
Host: example.com
The server might respond with this:
HTTP/1.1 307 Temporary Redirect
Access-Control-Allow-Origin: *
Location: https://wf.example.net/example.com/webfinger?
resource=acct%3Aalice%40example.com
The client can then follow the redirection, reissuing the request to
the URI provided in the Location header. Note that the server will
include any required URI parameters in the Location header value,
which could be different than the URI parameters the client
originally used.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Definition of WebFinger Applications</span>
This specification details the protocol syntax used to query a domain
for information about a URI, the syntax of the JSON Resource
Descriptor (JRD) that is returned in response to that query, security
requirements and considerations, hosted WebFinger services, various
expected HTTP status codes, and so forth. However, this
specification does not enumerate the various possible properties or
link relation types that might be used in conjunction with WebFinger
for a particular application, nor does it define what properties or
link relation types one might expect to see in response to querying
for a particular URI or URI scheme. Nonetheless, all of these
unspecified elements are important in order to implement an
interoperable application that utilizes the WebFinger protocol and
<span class="grey">Jones, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
MUST be specified in the relevant document(s) defining the particular
application making use of the WebFinger protocol according to the
procedures described in this section.
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Specification of the URI Scheme and URI</span>
Any application that uses WebFinger MUST specify the URI scheme(s),
and to the extent appropriate, what forms the URI(s) might take. For
example, when querying for information about a user's account at some
domain, it might make sense to specify the use of the "acct" URI
scheme [<a href="#ref-18" title=""The 'acct' URI Scheme"">18</a>]. When trying to obtain the copyright information for a
web page, it makes sense to specify the use of the web page URI
(either http or https).
The examples in Sections <a href="#section-3.1">3.1</a> and <a href="#section-3.2">3.2</a> illustrate the use of different
URI schemes with WebFinger applications. In the example in <a href="#section-3.1">Section</a>
<a href="#section-3.1">3.1</a>, WebFinger is used to retrieve information pertinent to OpenID
Connect. In the example in <a href="#section-3.2">Section 3.2</a>, WebFinger is used to
discover metadata information about a web page, including author and
copyright information. Each of these WebFinger applications needs to
be fully specified to ensure interoperability.
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Host Resolution</span>
As explained in <a href="#section-4">Section 4</a>, the host to which a WebFinger query is
issued is significant. In general, WebFinger applications would
adhere to the procedures described in <a href="#section-4">Section 4</a> in order to properly
direct a WebFinger query.
However, some URI schemes do not have host portions and there might
be some applications of WebFinger for which the host portion of a URI
cannot or should not be utilized. In such instances, the application
specification MUST clearly define the host resolution procedures,
which might include provisioning a "default" host within the client
to which queries are directed.
<span class="h3"><a class="selflink" id="section-8.3" href="#section-8.3">8.3</a>. Specification of Properties</span>
WebFinger defines both subject-specific properties (i.e., properties
described in <a href="#section-4.4.3">Section 4.4.3</a> that relate to the URI for which
information is queried) and link-specific properties (see <a href="#section-4.4.4.5">Section</a>
<a href="#section-4.4.4.5">4.4.4.5</a>). This section refers to subject-specific properties.
Applications that utilize subject-specific properties MUST define the
URIs used in identifying those properties, along with valid property
values.
<span class="grey">Jones, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
Consider this portion of the JRD found in the example in <a href="#section-3.2">Section 3.2</a>.
"properties" :
{
"http://blgx.example.net/ns/version" : "1.3",
"http://blgx.example.net/ns/ext" : null
}
Here, two properties are returned in the WebFinger response. Each of
these would be defined in a WebFinger application specification.
These two properties might be defined in the same WebFinger
application specification or separately in different specifications.
Since the latter is possible, it is important that WebFinger clients
not assume that one property has any specific relationship with
another property, unless some relationship is explicitly defined in
the particular WebFinger application specification.
<span class="h3"><a class="selflink" id="section-8.4" href="#section-8.4">8.4</a>. Specification of Links</span>
The links returned in a WebFinger response each comprise several
pieces of information, some of which are optional (refer to <a href="#section-4.4.4">Section</a>
<a href="#section-4.4.4">4.4.4</a>). The WebFinger application specification MUST define each
link and any values associated with a link, including the link
relation type ("rel"), the expected media type ("type"), properties,
and titles.
The target URI to which the link refers (i.e., the "href"), if
present, would not normally be specified in an application
specification. However, the URI scheme or any special
characteristics of the URI would usually be specified. If a
particular link does not require an external reference, then all of
the semantics related to the use of that link MUST be defined within
the application specification. Such links might rely only on
properties or titles in the link to convey meaning.
<span class="h3"><a class="selflink" id="section-8.5" href="#section-8.5">8.5</a>. One URI, Multiple Applications</span>
It is important to be mindful of the fact that different WebFinger
applications might specify the use of the same URI scheme, and in
effect, the same URI for different purposes. That should not be a
problem, since each of property identifier (see Sections <a href="#section-4.4.3">4.4.3</a> and
4.4.4.5) and link relation type would be uniquely defined for a
specific application.
It should be noted that when a client requests information about a
particular URI and receives a response with a number of different
property identifiers or link relation types that the response is
providing information about the URI without any particular semantics.
<span class="grey">Jones, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
How the client interprets the information SHOULD be in accordance
with the particular application specification or set of
specifications the client implements.
Any syntactically valid properties or links the client receives and
that are not fully understood SHOULD be ignored and SHOULD NOT cause
the client to report an error.
<span class="h3"><a class="selflink" id="section-8.6" href="#section-8.6">8.6</a>. Registration of Link Relation Types and Properties</span>
Application specifications MAY define a simple token as a link
relation type for a link. In that case, the link relation type MUST
be registered with IANA as specified in Sections <a href="#section-10.3">10.3</a>.
Further, any defined properties MUST be registered with IANA as
described in <a href="#section-10.4">Section 10.4</a>.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Security Considerations</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Transport-Related Issues</span>
Since this specification utilizes Cross-Origin Resource Sharing
(CORS) [<a href="#ref-7" title=""Cross-Origin Resource Sharing"">7</a>], all of the security considerations applicable to CORS are
also applicable to this specification.
The use of HTTPS is REQUIRED to ensure that information is not
modified during transit. It should be acknowledged that in
environments where a web server is normally available, there exists
the possibility that a compromised network might have its WebFinger
resource operating on HTTPS replaced with one operating only over
HTTP. As such, clients MUST NOT issue queries over a non-secure
connection.
Clients MUST verify that the certificate used on an HTTPS connection
is valid (as defined in [<a href="#ref-12" title=""HTTP Over TLS"">12</a>]) and accept a response only if the
certificate is valid.
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. User Privacy Considerations</span>
Service providers and users should be aware that placing information
on the Internet means that any user can access that information, and
WebFinger can be used to make it even easier to discover that
information. While WebFinger can be an extremely useful tool for
discovering one's avatar, blog, or other personal data, users should
also understand the risks.
<span class="grey">Jones, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
Systems or services that expose personal data via WebFinger MUST
provide an interface by which users can select which data elements
are exposed through the WebFinger interface. For example, social
networking sites might allow users to mark certain data as "public"
and then utilize that marking as a means of determining what
information to expose via WebFinger. The information published via
WebFinger would thus comprise only the information marked as public
by the user. Further, the user has the ability to remove information
from publication via WebFinger by removing this marking.
WebFinger MUST NOT be used to provide any personal data unless
publishing that data via WebFinger by the relevant service was
explicitly authorized by the person whose information is being
shared. Publishing one's personal data within an access-controlled
or otherwise limited environment on the Internet does not equate to
providing implicit authorization of further publication of that data
via WebFinger.
The privacy and security concerns with publishing personal data via
WebFinger are worth emphasizing again with respect to personal data
that might reveal a user's current context (e.g., the user's
location). The power of WebFinger comes from providing a single
place where others can find pointers to information about a person,
but service providers and users should be mindful of the nature of
that information shared and the fact that it might be available for
the entire world to see. Sharing location information, for example,
would potentially put a person in danger from any individual who
might seek to inflict harm on that person.
Users should be aware of how easily personal data that one might
publish can be used in unintended ways. In one study relevant to
WebFinger-like services, Balduzzi et al. [<a href="#ref-20" title=""Abusing Social Networks for Automated User Profiling"">20</a>] took a large set of
leaked email addresses and demonstrated a number of potential privacy
concerns, including the ability to cross-correlate the same user's
accounts over multiple social networks. The authors also describe
potential mitigation strategies.
The easy access to user information via WebFinger was a design goal
of the protocol, not a limitation. If one wishes to limit access to
information available via WebFinger, such as WebFinger resources for
use inside a corporate network, the network administrator needs to
take necessary measures to limit access from outside the network.
Using standard methods for securing web resources, network
administrators do have the ability to control access to resources
that might return sensitive information. Further, a server can be
employed in such a way as to require authentication and prevent
disclosure of information to unauthorized entities.
<span class="grey">Jones, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
<span class="h3"><a class="selflink" id="section-9.3" href="#section-9.3">9.3</a>. Abuse Potential</span>
Service providers should be mindful of the potential for abuse using
WebFinger.
As one example, one might query a WebFinger server only to discover
whether or not a given URI is valid. With such a query, the person
may deduce that an email identifier is valid, for example. Such an
approach could help spammers maintain a current list of known email
addresses and to discover new ones.
WebFinger could be used to associate a name or other personal data
with an email address, allowing spammers to craft more convincing
email messages. This might be of particular value in phishing
attempts.
It is RECOMMENDED that implementers of WebFinger server software take
steps to mitigate abuse, including malicious over-use of the server
and harvesting of user information. Although there is no mechanism
that can guarantee that publicly accessible WebFinger databases won't
be harvested, rate-limiting by IP address will prevent or at least
dramatically slow harvest by private individuals without access to
botnets or other distributed systems. The reason these mitigation
strategies are not mandatory is that the correct choice of mitigation
strategy (if any) depends greatly on the context. Implementers
should not construe this as meaning that they do not need to consider
whether to use a mitigation strategy, and if so, what strategy to
use.
WebFinger client developers should also be aware of potential abuse
by spammers or those phishing for information about users. As an
example, suppose a mail client was configured to automatically
perform a WebFinger query on the sender of each received mail
message. If a spammer sent an email using a unique identifier in the
'From' header, then when the WebFinger query was performed, the
spammer would be able to associate the request with a particular
user's email address. This would provide information to the spammer,
including the user's IP address, the fact the user just checked
email, what kind of WebFinger client the user utilized, and so on.
For this reason, it is strongly advised that clients not perform
WebFinger queries unless authorized by the user to do so.
<span class="h3"><a class="selflink" id="section-9.4" href="#section-9.4">9.4</a>. Information Reliability</span>
A WebFinger resource has no means of ensuring that information
provided by a user is accurate. Likewise, neither the resource nor
the client can be absolutely guaranteed that information has not been
manipulated either at the server or along the communication path
<span class="grey">Jones, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
between the client and server. Use of HTTPS helps to address some
concerns with manipulation of information along the communication
path, but it clearly cannot address issues where the resource
provided incorrect information, either due to being provided false
information or due to malicious behavior on the part of the server
administrator. As with any information service available on the
Internet, users should be wary of information received from untrusted
sources.
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. Well-Known URI</span>
This specification registers the "webfinger" well-known URI in the
"Well-Known URIs" registry as defined by <a href="./rfc5785">RFC 5785</a> [<a href="#ref-3" title=""Defining Well-Known Uniform Resource Identifiers (URIs)"">3</a>].
URI suffix: webfinger
Change controller: IETF
Specification document(s): <a href="./rfc7033">RFC 7033</a>
Related information: The query to the WebFinger resource will
include one or more parameters in the query string; see <a href="./rfc7033#section-4.1">Section 4.1
of RFC 7033</a>. Resources at this location are able to return a JSON
Resource Descriptor (JRD) as described in <a href="./rfc7033#section-4.4">Section 4.4 of RFC 7033</a>.
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. JSON Resource Descriptor (JRD) Media Type</span>
This specification registers the media type application/jrd+json for
use with WebFinger in accordance with media type registration
procedures defined in <a href="./rfc6838">RFC 6838</a> [<a href="#ref-10" title=""Media Type Specifications and Registration Procedures"">10</a>].
Type name: application
Subtype name: jrd+json
Required parameters: N/A
Optional parameters: N/A
In particular, because <a href="./rfc4627">RFC 4627</a> already defines the character
encoding for JSON, no "charset" parameter is used.
Encoding considerations: See <a href="./rfc6839#section-3.1">RFC 6839, Section 3.1</a>.
<span class="grey">Jones, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
Security considerations:
The JSON Resource Descriptor (JRD) is a JavaScript Object Notation
(JSON) object. It is a text format that must be parsed by entities
that wish to utilize the format. Depending on the language and
mechanism used to parse a JSON object, it is possible for an
attacker to inject behavior into a running program. Therefore,
care must be taken to properly parse a received JRD to ensure that
only a valid JSON object is present and that no JavaScript or other
code is injected or executed unexpectedly.
Interoperability considerations:
This media type is a JavaScript Object Notation (JSON) object and
can be consumed by any software application that can consume JSON
objects.
Published specification: <a href="./rfc7033">RFC 7033</a>
Applications that use this media type:
The JSON Resource Descriptor (JRD) is used by the WebFinger
protocol (<a href="./rfc7033">RFC 7033</a>) to enable the exchange of information between a
client and a WebFinger resource over HTTPS.
Fragment identifier considerations:
The syntax and semantics of fragment identifiers SHOULD be as
specified for "application/json". (At publication of this
document, there is no fragment identification syntax defined for
"application/json".)
Additional information:
Deprecated alias names for this type: N/A
Magic number(s): N/A
File extension(s): jrd
Macintosh file type code(s): N/A
Person & email address to contact for further information:
Paul E. Jones <paulej@packetizer.com>
Intended usage: COMMON
<span class="grey">Jones, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
Restrictions on usage: N/A
Author: Paul E. Jones <paulej@packetizer.com>
Change controller:
IESG has change control over this registration.
Provisional registration? (standards tree only): N/A
<span class="h3"><a class="selflink" id="section-10.3" href="#section-10.3">10.3</a>. Registering Link Relation Types</span>
<a href="./rfc5988">RFC 5988</a> established a "Link Relation Types" registry that is reused
by WebFinger applications.
Link relation types used by WebFinger applications are registered in
the "Link Relation Types" registry as per the procedures of <a href="./rfc5988#section-6.2.1">Section</a>
<a href="./rfc5988#section-6.2.1">6.2.1 of RFC 5988</a>. The "Notes" entry for the registration SHOULD
indicate if property values associated with the link relation type
are registered in the "WebFinger Properties" registry with a link to
the registry.
<span class="h3"><a class="selflink" id="section-10.4" href="#section-10.4">10.4</a>. Establishment of the "WebFinger Properties" Registry</span>
WebFinger utilizes URIs to identify properties of a subject or link
and the associated values (see Sections <a href="#section-8.3">8.3</a> and <a href="#section-8.6">8.6</a>). This
specification establishes a new "WebFinger Properties" registry to
record property identifiers.
<span class="h4"><a class="selflink" id="section-10.4.1" href="#section-10.4.1">10.4.1</a>. The Registration Template</span>
The registration template for WebFinger properties is:
o Property Identifier:
o Link Type:
o Description:
o Reference:
o Notes: [optional]
The "Property Identifier" must be a URI that identifies the property
being registered.
<span class="grey">Jones, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
The "Link Type" contains the name of a link relation type with which
this property identifier is used. If the property is a subject-
specific property, then this field is specified as "N/A".
The "Description" is intended to explain the purpose of the property.
The "Reference" field points to the specification that defines the
registered property.
The optional "Notes" field is for conveying any useful information
about the property that might be of value to implementers.
<span class="h4"><a class="selflink" id="section-10.4.2" href="#section-10.4.2">10.4.2</a>. The Registration Procedures</span>
The IETF has created a mailing list, webfinger@ietf.org, which can be
used for public discussion of the WebFinger protocol and any
applications that use it. Prior to registration of a WebFinger
property, discussion on the mailing list is strongly encouraged. The
IESG has appointed Designated Experts [<a href="#ref-13" title="">13</a>] who will monitor the
webfinger@ietf.org mailing list and review registrations.
A WebFinger property is registered with a Specification Required (see
<a href="./rfc5226">RFC 5226</a> [<a href="#ref-13" title="">13</a>]) after a review by the Designated Experts. The review
is normally expected to take on the order of two to four weeks.
However, the Designated Experts may approve a registration prior to
publication of a specification once the Designated Experts are
satisfied that such a specification will be published. In evaluating
registration requests, the Designated Experts should make an effort
to avoid registering two different properties that have the same
meaning. Where a proposed property is similar to an already-defined
property, the Designated Experts should insist that enough text be
included in the description or notes section of the template to
sufficiently differentiate the new property from an existing one.
The registration procedure begins with a completed registration
template (as defined above) sent to webfinger@ietf.org. Once
consensus is reached on the mailing list, the registration template
is sent to iana@iana.org. IANA will then contact the Designated
Experts and communicate the results to the registrant. The WebFinger
mailing list provides an opportunity for community discussion and
input, and the Designated Experts may use that input to inform their
review. Denials should include an explanation and, if applicable,
suggestions as to how to make the request successful if resubmitted.
<span class="grey">Jones, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
The specification registering the WebFinger property MUST include the
completed registration template shown above. Once the registration
procedure concludes successfully, IANA creates or modifies the
corresponding record in the "WebFinger Properties" registry.
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Acknowledgments</span>
This document has benefited from extensive discussion and review by
many of the members of the APPSAWG working group. The authors would
like to especially acknowledge the invaluable input of Eran Hammer-
Lahav, Blaine Cook, Brad Fitzpatrick, Laurent-Walter Goix, Joe
Clarke, Peter Saint-Andre, Dick Hardt, Tim Bray, James Snell, Melvin
Carvalho, Evan Prodromou, Mark Nottingham, Elf Pavlik, Bjoern
Hoehrmann, Subramanian Moonesamy, Joe Gregorio, John Bradley, and
others that we have undoubtedly, but inadvertently, missed.
The authors would also like to express their gratitude to the chairs
of the APPSAWG working group, especially Salvatore Loreto for his
assistance in shepherding this document. We also want to thank Barry
Leiba and Pete Resnick, the Applications Area Directors, for their
support and exhaustive reviews.
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. References</span>
<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>. Normative References</span>
[<a id="ref-1">1</a>] Bradner, S., "Key words for use in RFCs to Indicate Requirement
Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
[<a id="ref-2">2</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., Masinter, L.,
Leach, P., and T. Berners-Lee, "Hypertext Transfer Protocol
-- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.
[<a id="ref-3">3</a>] Nottingham, M. and E. Hammer-Lahav, "Defining Well-Known
Uniform Resource Identifiers (URIs)", <a href="./rfc5785">RFC 5785</a>, April 2010.
[<a id="ref-4">4</a>] Nottingham, M., "Web Linking", <a href="./rfc5988">RFC 5988</a>, October 2010.
[<a id="ref-5">5</a>] Crockford, D., "The application/json Media Type for JavaScript
Object Notation (JSON)", <a href="./rfc4627">RFC 4627</a>, July 2006.
[<a id="ref-6">6</a>] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, <a href="./rfc3986">RFC 3986</a>,
January 2005.
[<a id="ref-7">7</a>] Van Kesteren, A., "Cross-Origin Resource Sharing", W3C CORS,
July 2010, <<a href="http://www.w3.org/TR/cors/">http://www.w3.org/TR/cors/</a>>.
<span class="grey">Jones, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
[<a id="ref-8">8</a>] IANA, "Link Relations",
<<a href="http://www.iana.org/assignments/link-relations/">http://www.iana.org/assignments/link-relations/</a>>.
[<a id="ref-9">9</a>] IANA, "MIME Media Types",
<<a href="http://www.iana.org/assignments/media-types">http://www.iana.org/assignments/media-types</a>>.
[<a id="ref-10">10</a>] Freed, N., Klensin, J., and T. Hansen, "Media Type
Specifications and Registration Procedures", <a href="https://www.rfc-editor.org/bcp/bcp13">BCP 13</a>, <a href="./rfc6838">RFC 6838</a>,
January 2013.
[<a id="ref-11">11</a>] Phillips, A., Ed., and M. Davis, Ed., "Tags for Identifying
Languages", <a href="https://www.rfc-editor.org/bcp/bcp47">BCP 47</a>, <a href="./rfc5646">RFC 5646</a>, September 2009.
[<a id="ref-12">12</a>] Rescorla, E., "HTTP Over TLS", <a href="./rfc2818">RFC 2818</a>, May 2000.
[<a id="ref-13">13</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA
Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>, May 2008.
<span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>. Informative References</span>
[<a id="ref-14">14</a>] Perreault, S., "vCard Format Specification", <a href="./rfc6350">RFC 6350</a>, August
2011.
[<a id="ref-15">15</a>] Sakimura, N., Bradley, J., Jones, M., de Medeiros, B.,
Mortimore, C., and E. Jay, "OpenID Connect Messages 1.0",
July 2013,
<<a href="http://openid.net/specs/openid-connect-messages-1_0.html">http://openid.net/specs/openid-connect-messages-1_0.html</a>>.
[<a id="ref-16">16</a>] Hammer-Lahav, E., Ed., and B. Cook, "Web Host Metadata", <a href="./rfc6415">RFC</a>
<a href="./rfc6415">6415</a>, October 2011.
[<a id="ref-17">17</a>] Hammer-Lahav, E. and W. Norris, "Extensible Resource Descriptor
(XRD) Version 1.0",
<<a href="http://docs.oasis-open.org/xri/xrd/v1.0/xrd-1.0.html">http://docs.oasis-open.org/xri/xrd/v1.0/xrd-1.0.html</a>>.
[<a id="ref-18">18</a>] Saint-Andre, P., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22The+%27acct%27+URI+Scheme%22'>"The 'acct' URI Scheme"</a>, Work in Progress,
July 2013.
[<a id="ref-19">19</a>] Duerst, M., Masinter, L., and J. Zawinski, "The 'mailto' URI
Scheme", <a href="./rfc6068">RFC 6068</a>, October 2010.
[<a id="ref-20">20</a>] Balduzzi, M., Platzer, C., Thorsten, H., Kirda, E., Balzarotti,
D., and C. Kruegel "Abusing Social Networks for Automated User
Profiling", Recent Advances in Intrusion Detection, Springer
Berlin Heidelberg, March 2010,
<<a href="https://www.eurecom.fr/en/publication/3042/download/rs-publi-3042_1.pdf">https://www.eurecom.fr/en/publication/3042/download/</a>
<a href="https://www.eurecom.fr/en/publication/3042/download/rs-publi-3042_1.pdf">rs-publi-3042_1.pdf</a>>.
<span class="grey">Jones, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc7033">RFC 7033</a> WebFinger September 2013</span>
Authors' Addresses
Paul E. Jones
Cisco Systems, Inc.
7025 Kit Creek Rd.
Research Triangle Park, NC 27709
USA
Phone: +1 919 476 2048
EMail: paulej@packetizer.com
IM: xmpp:paulej@packetizer.com
Gonzalo Salgueiro
Cisco Systems, Inc.
7025 Kit Creek Rd.
Research Triangle Park, NC 27709
USA
Phone: +1 919 392 3266
EMail: gsalguei@cisco.com
IM: xmpp:gsalguei@cisco.com
Michael B. Jones
Microsoft
EMail: mbj@microsoft.com
URI: <a href="http://self-issued.info/">http://self-issued.info/</a>
Joseph Smarr
Google
EMail: jsmarr@google.com
URI: <a href="http://josephsmarr.com/">http://josephsmarr.com/</a>
Jones, et al. Standards Track [Page 28]
</pre>
|