In addition to SIF messages and strictly infrastructure-related objects like SIF_ZoneStatus
, the Infrastructure
Working Group occasionally defines data model objects that either do not fall neatly within the purview of currently
existing data model working groups (e.g. the Authentication object) or that can be provided by the ZIS and agents
alike—typically metadata about a zone as opposed to data directly originating from the K-12 instructional and
administrative environment (e.g. SIF_LogEntry
).
Click here for non-normative background/supplementary documentation from this group.
The Authentication object allows a system that stores usernames and/or passwords to share them with other applications through SIF. The provider of the Authentication object may only support providing a username or a password, or it may support both.
The Authentication object is also able to transmit a user's network identity through SIF. If the user has an account in a network directory system that supports LDAP, the user's distinguishedName or username is shared to uniquely identify the user to applications that support LDAP or native network authentication options.
Details of how to implement the password element are included below the object definition.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
Authentication | The Authentication object allows a system that stores usernames and/or passwords to share them with other applications through SIF. The provider of the Authentication object may only support providing a username or a password, or it may support both. The Authentication object is also able to transmit a user's network identity through SIF. If the user has an account in a network directory system that supports LDAP, the user's distinguishedName or username is shared to uniquely identify the user to applications that support LDAP or native network authentication options. | |||||
@ | RefId | M | The SIF RefId that uniquely identifies this authentication object. | RefIdType | ||
@ | SIF_RefId | M | The SIF RefId of a student or staff member | IdRefType | ||
@ | SIF_RefObject | M | The type of SIF object that the SIF_RefId attribute identifies. | values:
| ||
AuthenticationInfo | M | The authentication information for one system. | ||||
AuthenticationInfo/System | M | An identifying string for the system that supports this authentication information. | xs:normalizedString
| |||
@ | Type | M | Specific type of user identification. | values:
| ||
AuthenticationInfo/Username | O | The identification string for this user. | xs:normalizedString
| |||
AuthenticationInfo/DistinguishedName | O | This is the distinguished name of the user in a network directory system. | xs:normalizedString
| |||
AuthenticationInfo/PasswordList | O | Allows a provider or publisher to specify the same password using multiple algorithms, if supported. | List | |||
AuthenticationInfo/PasswordList/ Password | MR | A representation of the user's password using the given algorithm. | xs:base64Binary
| |||
@ | Algorithm | M | The method used to encrypt the user's password. See the implementation details below. | values:
| ||
@ | KeyName | M | The name of the key to be used for decryption of the password. Left blank for plain, encoded text (Algorithm attribute value of "base64") and hash algorithms. | xs:normalizedString
| ||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
While Authentication objects transported over SIF HTTPS are typically secure in transit, SIF objects are often stored in logs and databases. If the network infrastructure is not secure, the passwords could be subject to snooping from system users. Because of this, the design of the Authentication object requires that passwords never be transmitted in plain text, to prevent casual viewing. The design of this object allows passwords to be securely encrypted using a variety of encryption algorithms.
Passwords in the Authentication object can be shared in one of three ways as documented in the sections below.
Sharing a password using encoded text is a very insecure method, because it uses a well-known algorithm and the value is not encrypted. The only merit of using this method is that the password is not readable as plain text, and thus deters any casual attempt to read a password. To share passwords in this manner, the following steps must be followed:
Password
element with the algorithm set to base64
.
Password
element.
Sharing a hashed text version of a password means that the original password is not shared. Clear text passwords are not retrievable from values stored as hashes. These hashed values can only be used to verify passwords input by a user.
What is shared is a cryptographically secure hash of the password. This hash allows other applications to verify a user's password when s/he logs in by comparing the hash value, not the original password. To share passwords in this manner, the following steps must be followed:
Password
element with the algorithm set to MD5
or SHA1
.
Password
element.
Sharing a password using encrypted text can be very secure.
The key being used to encrypt the data should be known only to the applications.
The KeyName
attribute is used to allow agents to uniquely identify keys that are being used.
To share passwords in this manner, the following steps must be followed:
Password
element with the algorithm set to DES
, TripleDES
, RC2
, or AES
.
Password
element.
The XML in the Authentication example can be used to verify an agent's implementation of any of the published algorithms.
The password being shared for the sake of the example is ¿sècrèt
.
High-Unicode characters are being used in this example to validate proper encoding.
The actual Unicode characters are: U+00BF, U+0073, U+00E8, U+0063, U+0072, U+00E8, U+0074.
The encryption keys being used are as follows (in base 64 format)
Key Name | Key (in base64 format) |
64-BIT_KEY | dW7SKzwdn0Q= |
128-BIT_KEY | TcdilmUZ6qvbmegl2it2pA== |
192-BIT_KEY | mECbXMo+fOMWRwam7tyUEE59jbO9O0Z4 |
NOTE: Real-world implementations of password sharing should use keys other than the ones used for this documentation. These keys are provided for example's sake only. Keys should be generated using a secure cryptographic key generator.
This object captures an occurrence within a SIF node (ZIS or agent)—error, warning or information—for storage in an optionally provided zone log. SIF_LogEntry Adds are reported and are used to post new log entries to the provider of the log. Of course, subscribing agents may also filter incoming Adds as part of their own logging mechanism. Any Change or Delete SIF_Events should be ignored at the agent level, but should be routed by the ZIS (though this should not be necessary). Use of the log is optional and voluntary, except where noted as mandatory in this specification. Nodes may post as much or as little log data as required with the expectation that if there is a provider of SIF_LogEntry that the logged entries be available for a provider-defined amount of time subject to provider-defined restrictions on the quantity of data logged by any given node.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
SIF_LogEntry | This object captures an occurrence within a SIF node (ZIS or agent)—error, warning or information—for storage in an optionally provided zone log. SIF_LogEntry Adds are reported and are used to post new log entries to the provider of the log. Of course, subscribing agents may also filter incoming Adds as part of their own logging mechanism. Any Change or Delete SIF_Events should be ignored at the agent level, but should be routed by the ZIS (though this should not be necessary). Use of the log is optional and voluntary, except where noted as mandatory in this specification. Nodes may post as much or as little log data as required with the expectation that if there is a provider of SIF_LogEntry that the logged entries be available for a provider-defined amount of time subject to provider-defined restrictions on the quantity of data logged by any given node. | |||||
@ | Source | M | The SIF node that logged this entry. | values:
| ||
@ | LogLevel | M | The level of the log entry herein described. | values:
| ||
SIF_LogEntryHeader | M | This is a copy of the SIF_Event/SIF_Header in the message that added this SIF_LogEntry to the zone. This copy facilitates querying log entries with regard to source, time, optionally destination, etc. | ||||
SIF_LogEntryHeader/SIF_Header | M | SIF_Header | ||||
SIF_OriginalHeader | O | If this log entry references a previous SIF_Message, this element contains a copy of the referenced message's SIF_Header. | ||||
SIF_OriginalHeader/SIF_Header | M | SIF_Header | ||||
SIF_Category | C | A SIF_LogEntry category. May be omitted for informational-type postings, where typically a textual description will suffice. Note that categories may be combined with the Source attribute of SIF_LogEntry to differentiate agent error conditions from ZIS error conditions. | values:
| |||
SIF_Code | O | A SIF_LogEntry code with regard to SIF_Category above. May be omitted for informational-type postings, where typically a textual description will suffice. If a SIF_Code is included, SIF_Category must be included as well. | union of: SIF_LogEntrySuccessCategoryType SIF_LogEntryDataIssuesWithSuccessResultType SIF_LogEntryDataIssuesWithFailureResultType SIF_LogEntryAgentErrorConditionType SIF_LogEntryZISErrorConditionType | |||
SIF_ApplicationCode | O | An error code specific to the application posting the entry. Can be used by vendors to query log entries for errors specific to their applications. If a SIF_ApplicationCode is included, SIF_Category must be included as well; i.e., application-specific error codes should fall within one of the defined log entry categories. | xs:normalizedString
| |||
SIF_Desc | M | A textual description of the error. | xs:string
| |||
SIF_ExtendedDesc | O | Any extended error description. | xs:string | |||
SIF_LogObjects | O | List | ||||
SIF_LogObjects/SIF_LogObject | MR | Any SIF data objects to which this log entry may apply. | SIF_ResponseObjectType | |||
@ | ObjectName | M | The name of the SIF object referenced (e.g. StudentPersonal). | SIF_RequestObjectNamesType | ||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |