idnits 2.17.1 draft-johansson-fticks-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document seems to contain a disclaimer for pre-RFC5378 work, but was first submitted on or after 10 November 2008. The disclaimer is usually necessary only for documents that revise or obsolete older RFCs, and that take significant amounts of text from those RFCs. If you can contact all authors of the source material and they are willing to grant the BCP78 rights to the IETF Trust, you can and should remove the disclaimer. Otherwise, the disclaimer is needed and you can ignore this comment. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (October 03, 2013) is 3855 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- No issues found here. Summary: 1 error (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force L. Johansson, Ed. 3 Internet-Draft SUNET 4 Intended status: Informational S. Winter 5 Expires: April 06, 2014 Restrena 6 October 03, 2013 8 F-Ticks - A Federation Log Format 9 draft-johansson-fticks-00 11 Abstract 13 This document describes a log format for distributed identity 14 federations that can be used as a tool for meetering and statistics 15 gathering. 17 Requirements Language 19 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 20 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 21 document are to be interpreted as described in RFC 2119 [RFC2119]. 23 Status of This Memo 25 This Internet-Draft is submitted in full conformance with the 26 provisions of BCP 78 and BCP 79. 28 Internet-Drafts are working documents of the Internet Engineering 29 Task Force (IETF). Note that other groups may also distribute 30 working documents as Internet-Drafts. The list of current Internet- 31 Drafts is at http://datatracker.ietf.org/drafts/current/. 33 Internet-Drafts are draft documents valid for a maximum of six months 34 and may be updated, replaced, or obsoleted by other documents at any 35 time. It is inappropriate to use Internet-Drafts as reference 36 material or to cite them other than as "work in progress." 38 This Internet-Draft will expire on April 06, 2014. 40 Copyright Notice 42 Copyright (c) 2013 IETF Trust and the persons identified as the 43 document authors. All rights reserved. 45 This document is subject to BCP 78 and the IETF Trust's Legal 46 Provisions Relating to IETF Documents 47 (http://trustee.ietf.org/license-info) in effect on the date of 48 publication of this document. Please review these documents 49 carefully, as they describe your rights and restrictions with respect 50 to this document. Code Components extracted from this document must 51 include Simplified BSD License text as described in Section 4.e of 52 the Trust Legal Provisions and are provided without warranty as 53 described in the Simplified BSD License. 55 This document may contain material from IETF Documents or IETF 56 Contributions published or made publicly available before November 57 10, 2008. The person(s) controlling the copyright in some of this 58 material may not have granted the IETF Trust the right to allow 59 modifications of such material outside the IETF Standards Process. 60 Without obtaining an adequate license from the person(s) controlling 61 the copyright in such materials, this document may not be modified 62 outside the IETF Standards Process, and derivative works of it may 63 not be created outside the IETF Standards Process, except to format 64 it for publication as an RFC or to translate it into languages other 65 than English. 67 Table of Contents 69 1. Introduction and Motivation . . . . . . . . . . . . . . . . . 2 70 2. F-ticks Semantics . . . . . . . . . . . . . . . . . . . . . . 3 71 3. F-ticks Format . . . . . . . . . . . . . . . . . . . . . . . 3 72 4. Common F-ticks Attributes . . . . . . . . . . . . . . . . . . 3 73 4.1. REALM . . . . . . . . . . . . . . . . . . . . . . . . . . 3 74 4.2. VISCOUNTRY . . . . . . . . . . . . . . . . . . . . . . . 4 75 4.3. VISINST . . . . . . . . . . . . . . . . . . . . . . . . . 4 76 4.4. CSI . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 77 4.5. RESULT . . . . . . . . . . . . . . . . . . . . . . . . . 4 78 4.6. RP . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 79 4.7. AP . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 80 4.8. TS . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 81 4.9. AM . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 82 4.10. PN . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 83 5. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 4 84 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 5 85 7. Security Considerations . . . . . . . . . . . . . . . . . . . 5 86 8. Normative References . . . . . . . . . . . . . . . . . . . . 5 87 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 89 1. Introduction and Motivation 91 Identity federations are often built as loosly coupled systems of 92 identity providers and relying parties. In such a system it is often 93 important to collect statistics and meetering in a consistent way. 95 This document describes a simple (yet extensible) tex logformat which 96 can be to communicate the essential aspects of authentication events 97 to log reception software (eg syslog [RFC5424]). 99 2. F-ticks Semantics 101 An F-ticks log stream consists of a series of F-ticks log messages, 102 each one represents a single authentication event. Each log message 103 is generated at a federation entity (eg an identity provider or a 104 relying party). 106 3. F-ticks Format 108 An F-ticks log message is a text string that fulfills the following 109 ABNF [RFC5234]: 111 fticks = "F-TICKS/" federation-identifier "/" version attribute-list 112 label = ( ALPHA / DIGIT / '_' / '-' / ':' / '.' / ',' / ';') 113 federation-identifier = label 114 version = label 115 attribute-list = 1*("#" attribute "=" value ) "#" 116 value = label 117 attribute = ( ALPHA / DIGIT ) 119 The federation-identifier and version can be used by federations and 120 other communities to indicate the type of attributes used. This 121 document does not describe any mandatory attributes but instead 122 provides a list of attributes in use in various communities today. 124 Future versions of this document may want to define an IANA registry 125 for f-tick attribute definitions. 127 Because of size constraints common to several log systems it is 128 expected that f-ticks attributes are kept short. 130 4. Common F-ticks Attributes 132 In general a log consumer should not assume that any one attribute is 133 present. Depending on the situation any one of these (or any other 134 defined attributes) may be missing from an F-ticks message. 136 4.1. REALM 138 The REALM attribute is used to convey the AAA-realm (eg RADIUS) of 139 the authentication event. The presence of the REALM attribute 140 implies that the message was generated by a AAA-based identity 141 provider. 143 4.2. VISCOUNTRY 145 The ISO country code of the entity that generated the log messages. 147 4.3. VISINST 149 TODO 151 4.4. CSI 153 The Calling Station ID of the subject associated with the 154 authentication event. The presence of this attribute implies that 155 the message was generated by an AAA-based identity provider. 157 4.5. RESULT 159 The result of the authentication event - either 'OK' or 'FAIL'. 161 4.6. RP 163 Relying Party identifier. A string uniquely identifying the relying 164 party invoved in the authentication event. 166 4.7. AP 168 Asserting party identifier. A string uniquely identifying the party 169 making the claim towards the relying party. For an authentication 170 event this is the identity provider. For an attribute authority 171 lookup event this is the AA identifier. 173 4.8. TS 175 A timestamp (seconds since the epoch) associated with the 176 authentication event. If this attribute is absent the consumer MAY 177 choose to use a timestamp provided by the log message system (eg 178 syslog) instead. 180 4.9. AM 182 Authentication Method identifier. 184 4.10. PN 186 A unique identifier for the subject involved in the event. 188 5. Examples 190 TBD 192 6. Acknowledgements 194 The f-ticks log format has been in use in the eduroam community since 195 TTT and was originally conceived as a usage-tracking mechanism by 196 Stefan Winter. 198 7. Security Considerations 200 Improperly configured logging may leak sensitive user information. 201 In particular the PN attribute value (subject identitier) should be 202 masked with a cryptographically keyed hash function before 203 transmission. 205 8. Normative References 207 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 208 Requirement Levels", BCP 14, RFC 2119, March 1997. 210 [RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax 211 Specifications: ABNF", STD 68, RFC 5234, January 2008. 213 [RFC5424] Gerhards, R., "The Syslog Protocol", RFC 5424, March 2009. 215 Authors' Addresses 217 Leif Johansson (editor) 218 SUNET 220 Email: leifj@sunet.se 222 Stefan Winter 223 Restrena 225 Email: stefan.winter@restrena.lu