view Side-By-Side changes
INTERNET DRAFT J. Abela Expires:JulyJanuary 22, 1997 HSC<draft-abela-ulm-01.txt><draft-abela-ulm-02.txt> 22JanuaryJuly 1997 Universal Format for Logger Messages Status of this Memo This document is an Internet-Draft. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet- Drafts as reference material or to cite them other than as ``work in progress.'' To learn the current status of any Internet-Draft, please check the ``1id-abstracts.txt'' listing contained in the Internet- Drafts Shadow Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe), munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or ftp.isi.edu (US West Coast). Abstract This document presents a format to describe system events for logging purpose. Some of the features presented here are already in use with the common syslog facility, but most of them are lost in the crowd of syslog format freedom. Introduction At the beginning, logs were scanned by the administrator after an incident to detect the failure cause. With the increasing concern on computer security, and wide area network manangement, the need for automated log examination, extraction and reporting has grown. The Universal Logger Message (ULM) format presented here is a set of guidelines to formalize the semantics of such messages. In a ULM, each piece of data is marked with a tag to specify its meaning. In the message "gandalf is unavailable", even a human administrator could difficultly determine whether "gandalf" is a host, a user nickname, a network, or an application. But the "filename=gandalf status=unavailable" notation desambiguates the meaning of each piece of data, and allows an automatic processing of the message. Abela [Page 1] INTERNET-DRAFT Universal Logger Messages 22 July 1997 SyntaxThe ABNFThis specification uses the Augmented Backus-Naur Form (ABNF) notation specified in another document. Just note that "a*b xxx" means "xxx repeated between a and b times", the default values being 0 forULM is:a, and infinite for b. log_file = *(log_line LF) log_line = field *(SP field)Abela [Page 1] INTERNET-DRAFT Universal Logger Messages 22 January 1997field = field_name "=" field_value field_name = ALPHA *(ALPHA_EXT) (Case is notsignificant)significant for the field names) field_value = *(ALPHA_EXT) / string string = QUOTE *(ANY) QUOTE (inside a string, quotes and backslashes must be escaped with a backslash) ANY = <anyCHARISO-8859-1 character excludingallcontrolcharacters (US ASCII 0-31 inclusive)>characters> ALPHA_EXT = ALPHA / DIGIT / "." / "-" / "_" QUOTE = <the double quote character (ASCII decimal code 34)> ALPHA = <any one of the 52 alphabetic characters (A through Z in upper case and a through z in lower case)> DIGIT = <any one of the 10 numeric characters (0 through 9)> LF = <the line-feed character (ASCII decimal code 10)> SP = <the space character (ASCII decimal code 32)> To use the field names as a hierarchical tree, field name elements can be concatenated with dots in between. Due to the verbosity of ULM, field names should be chosen as short as possible: 4 characters are a maximum for a field name element. Here is a correct syslog message: Jan 20 00:05:03 myhost:10.3.2.110.0.2.1 tuttle from space.foo-bar.com(10.3.3.5)(10.1.3.5) 3456 Abela [Page 2] INTERNET-DRAFT Universal Logger Messages 22 July 1997 Its meaning is however context and reader dependant, and could not be parsed successfully without a precise knowledge of all the type of messages wich could happen. An ULM for this could be: DATE=19970120000503 HOST=itesecPRG=foo-gwPROG=foo-gw LVL=debug PS=3456 DST.IP=10.3.2.1 DST.USR=tuttle SRC.IP=10.3.3.5 SRC.FQDN=space.foo- bar.com Mandatory Fields The following fields should be present in any ULM:LVL,DATE, HOST,PRG, DATE. ThisLVL, PROG in this order. For readability purpose, this requirement is not enforced through the examples of thisAbela [Page 2] INTERNET-DRAFT Universal Logger Messages 22 January 1997document. LVL value.level = "Emergency" / "Alert" / "Error" / "Warning" / "Auth" / "Security" / "Usage" / "System" / "Important" / "Debug" The level (LVL) field specifies the importance and category of the ULM. The meaning for the different values are: Emergency A panic condition. It should be broadcast to all users. Alert A condition that should be corrected immediately. Error A system error. This level and the previous ones are reserved for system conditions. Warning A program error. A program has detected an incorrect behaviour of his own. To clarify the differences between these last levels: Absence of a system configuration file is an Error, failed assert is a Warning, and erroneous data given by a user is never anything more than a Debug (except when asked for authentication pasphrase, see below). Auth An authentication happened. Potential senders for such an Abela [Page 3] INTERNET-DRAFT Universal Logger Messages 22 July 1997 ULM could be su and login. The STAT field may give more informations; if not specified, an authentication failure is assumed, as in:PRG=suPROG=su LVL=Auth PS=2894 SRC.USR=tuttle DST.USR=rootPRG=suPROG=su LVL=Auth PS=2895 SRC.USR=tuttle DST.USR=root STAT=Success Security A standard protection was raised against what could be anAbela [Page 3] INTERNET-DRAFT Universal Logger Messages 22 January 1997intrusion. A connection denial based on the remote network address falls into this category. The STAT field may give more informations; if not specified, a failure is assumed, as in:PRG=tcpwrapperPROG=tcpwrapper LVL=Security SRC.NAME=evil.foo-bar.com Usage Normal, standard, authorized day-to-day usage information. If an application has to report delayed information about what is used, it should be reported as debugging information first (for crashproof logging), then summaried into an only usage message. DATE=19970120000503PRG=www-clientPROG=www-client LVL=Debug STAT=Start DATE=19970120000551PRG=www-clientPROG=www-client LVL=Debug STAT=End DATE=19970120000551PRG=www-clientPROG=www-client LVL=Usage DUR=48 System Tangible usage, but not traceable to any user. Automated processus or system batch jobs fall into this category.PRG=sshdPROG=sshd LVL=System PS=175 MSG="RSA key generation" DUR=37 Important Important information which could become critical, but is not yet. A configuration change may be an important information. Debug Abela [Page 4] INTERNET-DRAFT Universal Logger Messages 22 July 1997 The Debug level ULMs are not interesting at all in the normal course of life, they add no information when everything is in order. HOST value.host = string The HOST field contains the name of the host which issues the ULM. PROGAbela [Page 4] INTERNET-DRAFT Universal Logger Messages 22 January 1997value.prog = string The PROG field contains the name of the software component which issues the ULM. If a software component is a member of a software suite, it should be expressed in ahierarchical,hierarchical structure ("suite.component.subcomponent") asin: "suite.component.subcomponent".in "inn.innfeed". DATE value.date = <YYYY> <MM> <DD> <hh> <mm> <ss> [ '.' <decimals> ] [ ( '+' / '-' ) <hh> <mm> ] The DATE field contains the instantaneous date of the event. If the event lasts a sufficient amount of time, different ULM sould be issued, each marked with its own date. The given date must either be in GMT, or include a timezoneinformation.information, from a GMT point of view (+0300 means GMT+0300). Optional Fields The following fields could be added in any ULM. Any application reading log files should understand them: DUR, PS, ID, SRC.IP, SRC.FQDN, SRC.NAME, SRC.PORT, SRC.USR, SRC.MAIL, DST.*, REL.*, VOL, VOL.SENT, VOL.RCVD, CNT, CNT.SENT, CNT.RCVD, PROG.FILE, PROG.LINE, STAT, TTY, DOC, PROT, CMD, MSG. DUR value.duration = integer The DURATION indicates the duration (in seconds) of the event which end is given by the DATE field. This field is mandatory if the ULM announces the end of an eventfor which another ULM was issued at the beginning.started earlier. Abela [Page 5] INTERNET-DRAFT Universal Logger Messages 22 July 1997 PS value.process = integer In a multi-tasking environment, this field specifies the process id which issued the ULM. On some systems, this id may not be unique, but it should however be unique on the specified HOST, over the specified DUR, if appropriate. Thus, the ULM announcing the end of a session should specify the duration of the session, and guarantee that all the ULM issued between the beginning of the session and this ULM with the same HOST value and the same PS values concern that session.Abela [Page 5] INTERNET-DRAFT Universal Logger Messages 22 January 1997ID value.id = string The ID field is a system reference to the concerned document. It could be a mail or Usenet news message-id, or an incremented counter. It should not be mistaken with the DOC field, which a user-level name. SRC.IP value.source.ip = ipv4 / ipv6 ipv4 = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT ipv6 = 16HEX The SRC.IP field contains the IP number of the source host. Other SRC.* fields could describe network source addresses in other realms (IPX, X25, ...). The SRC.* fields all contain informations about the connected, connecting, or trying to connect host. SRC.FQDN value.source.fqdn = string Fully Qualified Domain Name for the source host. SRC.NAME value.source.name = string Abela [Page 6] INTERNET-DRAFT Universal Logger Messages 22 July 1997 Generic name qualifying the source: a host name if fqdn is not available, or a full user name. SRC.PORT value.source.port = 2-byte unsigned integer Port number for TCP, UDP or another protocol. SRC.USR value.source.user = string User name or user id. SRC.MAIL value.source.mail = stringAbela [Page 6] INTERNET-DRAFT Universal Logger Messages 22 January 1997E-mail address. DST.IP DST.FQDN DST.NAME DST.PORT DST.USR DST.MAIL All the DST.* fields have the same meaning as the SRC.* fields, except that they qualify the destination. REL.IP REL.FQDN REL.NAME REL.PORT REL.USR REL.MAIL All the REL.* fields have the same meaning as the SRC.* fields, except that they qualify a proxy, or relayer, or some sort of man-in-the-middle. VOL VOL.SENT VOL.RCVD CNT CNT.SENT CNT.RCVD Volume (number of bytes) and count (of articles, files, events) sent, and received, from the source point of view. CNT=1 is always implicit. These fields allow ULM to be merged together, in which case, the VOL and CNT fields may be added together, if the other ones match. PROG.FILE Name of the program source file from which the ULM was generated. This field is usefull for warning messages, such as "out of memory", "can't fork", or "assert failed". PROG.LINE Abela [Page 7] INTERNET-DRAFT Universal Logger Messages 22 July 1997 Line number of the PROG.FILE source file from which the ULM was generated. STAT The STAT field describes the state or status of the designed process. Possible values for this field may include "Failure", "Success", "Start", "End". TTY value.tty = string The tty field describes the user's physical connection to the host. DOC value.document = string The document (DOC) field is the name of an accessed document, like the path of an ftp file, the name of a newsgroup, or the non-host part of an URL. PROT value.protocol = string The protocol (PROT) field specifies the protocol used.Abela [Page 7] INTERNET-DRAFT Universal Logger Messages 22 January 1997 PRG=sendmailPROG=sendmail VOL=2238 PROT=ESMTPPRG=sshdPROG=sshd PROT=RSA LVL=Auth STAT=Success CMD value.command = string The command (CMD) field is an issued command, as in:PRG=cronPROG=cron LVL=Usage SRC.USR=news CMD="/local/news/bin/news.daily expireover delayrm" DUR=927PRG=ftpdPROG=ftpd LVL=Usage PS=10359 CMD=RETR DOC=x11.tar.gz MSG value.message = string Abela [Page 8] INTERNET-DRAFT Universal Logger Messages 22 July 1997 The message (MSG) field is the only field which should contain arbitrary data. Any important information that doesn't fit any of the other standard fields may be stored here. Using the message field for information fitting in standard field is forbidden. Other more fieldsAny other fieldIt is expected that the set ofinterest could be added, but it should be registered firstfield names will grow significantly with time. In order to ensure that the set of such names is developed in an orderly, well-specified, and public manner, ULM defines a registration process which uses the Internet AssignedNumberNumbers Authority(IANA).(IANA) as a central registry for such values. Here is a template for the registration of new field names with IANA. To: IANA@isi.edu Subject: Registration of new ULM field name ULM field name: Encoding specifications: Interpretation: (full explanation for the expected use of this field) Submitted by: (person and email address to contact for further information) Security Considerations ULM includes no security functions. However, sites should worry about the vulnerabilites of their logging architecture, especially when networks are used to transport ULM, as these messages may be critical for the security. Author's Address Jerome Abela Herve Schauer Consultants 142, rue de Rivoli 75001 Paris France Phone: +33146 388 990141 409 700 Fax: +33146 380 505 Abela [Page 8] INTERNET-DRAFT Universal Logger Messages 22 January 1997141 409 709 EMail: Jerome.Abela@hsc.fr Abela [Page 9] ----