home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1997 December / Internet_Info_CD-ROM_Walnut_Creek_December_1997.iso / drafts / draft_ietf_i / draft-ietf-ids-ph-03.txt < prev    next >
Text File  |  1997-05-07  |  33KB  |  1,066 lines
  1.  
  2.  
  3.  
  4. IDS Working Group                                   Roland Hedberg
  5. INTERNET-DRAFT                                     Umea University
  6.                                                         Paul Pomes
  7.                                                      QUALCOMM, Inc
  8.  
  9.  
  10.                  The CCSO Nameserver (Ph) Architecture
  11.  
  12.  
  13. Status of this Memo
  14.  
  15.  
  16.    This document is an Internet-Draft.  Internet-Drafts are working
  17.    documents of the Internet Engineering Task Force (IETF), its areas,
  18.    and its working groups.  Note that other groups may also distribute
  19.    working documents as Internet-Drafts.
  20.  
  21.    Internet-Drafts are draft documents valid for a maximum of six months
  22.    and may be updated, replaced, or obsoleted by other documents at any
  23.    time.  It is inappropriate to use Internet-Drafts as reference
  24.    material or to cite them other than as ``work in progress.''
  25.  
  26.    To learn the current status of any Internet-Draft, please check the
  27.    ``1id-abstracts.txt'' listing contained in the Internet-Drafts Shadow
  28.    Directories on ds.internic.net (US East Coast), nic.nordu.net
  29.    (Europe), ftp.isi.edu (US West Coast), or munnari.oz.au (Pacific
  30.    Rim).
  31.  
  32. Abstract
  33.  
  34.    The PH Nameserver from the [Computing and Communications Services
  35.    Office (CCSO),] University of Illinois at Urbana-Champaign has for
  36.    some time now been used by several organizations as their choice of
  37.    publicly available database for information about people as well as
  38.    other things.  It is now widely felt that the Internet community
  39.    would benefit from having a more rigorous definition of the client-
  40.    server protocol, this document will hopefully achieve that goal.  The
  41.    Ph service as specified in this document is built around an informa-
  42.    tion model, a client command language and the server responses.
  43.  
  44.  
  45. 1.  Overview
  46.  
  47. 1.1.  Basic Information Model
  48.  
  49.    At its simplest, the Ph database can be thought of as a computer
  50.    resident "phone book".  However, it can be used to collect arbitrary
  51.    information about people or things, and in response to a query about
  52.  
  53.  
  54.  
  55.                                                                 [Page 1]
  56.  
  57. INTERNET DRAFT                                                  May 1997
  58.  
  59.  
  60.    an object named in the database, return information about that
  61.    entity.  It is in short a nameserver for people and objects.  It was
  62.    designed to keep a relatively small amount of arbitrary information
  63.    about a relatively large number of people or things, and provide
  64.    access to that information over the Internet.  In order to structure
  65.    the information the manager of the database has to decide which views
  66.    he wants to present of the real-world objects that are to be
  67.    represented in the database.  Each view is then composed of a number
  68.    of fields and their values.  To support this concept Ph has the
  69.    notion of named information; that is categorizing information into
  70.    what are called fields and assigning descriptive names to those
  71.    fields.
  72.  
  73.    Even if the database resides and is reachable from the Internet it is
  74.    local in the meaning that no server is supposed to be able to refer a
  75.    client to another server which might hold the wanted information.
  76.    However a server may contain a list of other Nameservers which can be
  77.    used by clients to query other Nameservers for information.
  78.  
  79. 1.1.1.  Fields
  80.  
  81.    A field descriptor is associated with each field and is used to
  82.    describe the type and behavior of the field.  A field descriptor
  83.    includes the fieldname, the maximum length of the field, keywords
  84.    describing the properties of the field as well as free text describ-
  85.    ing what kind of information the field is supposed to hold.
  86.  
  87.    The keywords can be one of the following:
  88.  
  89.    Always:   Forces the field's contents to be always printed in addi-
  90.              tion to whatever fields specified by the query.
  91.  
  92.    Any:      This field is always searched by queries.  To most useful,
  93.              a field marked as Any should also have the Indexed and
  94.              Lookup keywords as well.
  95.  
  96.    Change:   Can be changed by the owner of the entry.
  97.  
  98.    Default:  Printed if no return clause is given in the query.
  99.  
  100.    Encrypt:  Must be encrypted before transmission.
  101.  
  102.    ForcePub: Viewable/searchable regardless of the content of the
  103.              suppress field
  104.  
  105.    Indexed:  Fields marked Indexed are kept track of in the database's
  106.              index for efficient lookups.  At least one indexed field
  107.              must be present in each query.
  108.  
  109.  
  110.  
  111.                                                                 [Page 2]
  112.  
  113. INTERNET DRAFT                                                  May 1997
  114.  
  115.  
  116.    LocalPub: May be viewed by anyone in the "local" domain or address
  117.              space.  Fields with the LocalPub property are completely
  118.              invisible outside of the "local" domain and will not be
  119.              shown with the fields command (section 3.4), is disallowed
  120.              in query/ph commands (section 3.9), and can not be used in
  121.              return clauses (section 3.10) for anyone outside of the
  122.              "local" domain.
  123.  
  124.    Lookup:   May be used in the selection part of a query; a field not
  125.              marked Lookup may not be used to select entries.
  126.  
  127.    NoMeta:   Wildcard searches are disallowed.
  128.  
  129.    NoPeople: No entry of type "person" may include this field.
  130.  
  131.    Private:  Field may be viewed by heros only.
  132.  
  133.    Public:   May be viewed by anyone, fields not marked public may only
  134.              be viewed by the entry's owner or a hero.
  135.  
  136.    Sacred:   Changes to the field are prohibited except via non-network
  137.              invocations of the server, i.e., from a tty, file, or pipe.
  138.  
  139.    Turn:     Users may turn off visibility of a field to everyone except
  140.              himself and heros by prefixing the field text with '*'.
  141.  
  142.    Unique    Any change to the field will be rejected if the change
  143.              causes the field to match the same field in any other
  144.              entry.
  145.  
  146. 1.1.2.  Character Sets
  147.  
  148.    Historically Ph has been restricted to only handle printable charac-
  149.    ters, that is characters with hexadecimal values between 0x20 and
  150.    0x7f.  Lately with the spreading of 8-bit clean Operating Systems
  151.    there is no reason to keep this limitation.
  152.  
  153.    This document therefore proposes that ISO-8859-1 shall be regarded as
  154.    an alternative character set for PH, the default still being US-
  155.    ASCII.
  156.  
  157.    If a client can handle ISO-8859-1 it should request the server to
  158.    return ISO-8859-1 by using the "set"-command.
  159.  
  160. 1.2.  Standardization issues
  161.  
  162.    Each Nameserver manager is in essence free to name new fields to suit
  163.    the special needs of his/her organization.  But in order to make the
  164.  
  165.  
  166.  
  167.                                                                 [Page 3]
  168.  
  169. INTERNET DRAFT                                                  May 1997
  170.  
  171.  
  172.    directory service useful even outside of the organization it is
  173.    recommended that a core set of standard fields always should be
  174.    present.
  175.  
  176.    Therefore this document defines a couple of standard collections of
  177.    fields (Appendix A).
  178.  
  179.    Also note that the architecture makes no assumption about the search
  180.    and retrieval mechanisms used within individual servers.  Operators
  181.    are thereby free to use any kind of dedicated databases, fast index-
  182.    ing software or even gateways to other directory services to store
  183.    and retrieve the information, if desired.
  184.  
  185.    The Ph simply functions as a known front-end, offering a simple data
  186.    model as well as a well known port and simple query language.
  187.  
  188. 1.3.  Conventions Used in this Document
  189.  
  190.    In examples, "C:" and "S:" indicate lines sent by the client and
  191.    server respectively.
  192.  
  193. 1.4.  Heros
  194.  
  195.    For Ph a hero is equivalent to a superuser or operator.  Being in
  196.    hero mode means that some or all artificial limits are removed; full
  197.    heros may change any field in any entry in the database, as well as
  198.    view as many entries as he wishes.  Heros can also be limited to one
  199.    field of one other entry.  Hero mode is used mostly for administra-
  200.    tive purposes, delegation of group authority over selected fields,
  201.    and is controlled by the acl field.
  202.  
  203. 2.  Basic Operation
  204.  
  205.    Initially, the server host starts the Ph service by listening on TCP
  206.    port 105.  When a client host wishes to make use of the service, it
  207.    establishes a TCP connection to the server host.  The client and the
  208.    Ph server then exchanges commands and responses (respectively) until
  209.    the connection is closed or aborted.
  210.  
  211. 2.1.  Command syntax
  212.  
  213.    Commands in Ph consist of a keyword optionally followed by zero or
  214.    more keywords or values, separated by spaces, tabs or newlines, and
  215.    followed by a carriage return-linefeed (CRLF) pair.  A more thorough
  216.    description using BNF is given in Appendix C.
  217.  
  218.    Values containing spaces, tabs or newlines must be enclosed in double
  219.    quotes ('"').  In addition the sequences "\n", "\t","\"" and "\\" may
  220.  
  221.  
  222.  
  223.                                                                 [Page 4]
  224.  
  225. INTERNET DRAFT                                                  May 1997
  226.  
  227.  
  228.    be used to mean newline, tab, double quote and backslash, respec-
  229.    tively.
  230.  
  231.    Keywords must be given in lower case; case in the values of fields is
  232.    preserved, although queries are not case-sensitive.
  233.  
  234. 2.2.  Response syntax
  235.  
  236.    Responses consist of a result code followed by additional information
  237.    possibly separated by entry index and/or field name and are ter-
  238.    minated by a CRLF pair.
  239.  
  240.         result code:[entry index:][field name:]text
  241.  
  242.    Responses to some commands might be multi-lined.  In these cases each
  243.    line, except the last, in the response has the appropriate result
  244.    code, negated (prefaced with "-").  The last line then starts with
  245.    the appropriate result code, without negation.  Each line must be
  246.    terminated by a CRLF pair.
  247.  
  248.    If a particular command can apply to more than one entry, then the
  249.    multilined response must be so organized that all information per-
  250.    taining to one entry is return on consecutive lines, and that all
  251.    those lines must have one and the same entry index directly following
  252.    the resultcode.  The first entry index should be 1, and be incre-
  253.    mented each time a new entry is being referred to.
  254.  
  255.         C: query hedberg return email name title
  256.         S: 102:There were 3 matches to your request.
  257.         S: -200:1:        email: canheg95@student.umu.se
  258.         S: -200:1:         name: Carl Johan Hedberg
  259.         S: -200:1:        title: Student
  260.         S: -200:2:        email: parheg95@student.umu.se
  261.         S: -200:2:         name: Par Hedberg
  262.         S: -200:2:        title: Student
  263.         S: -200:3:        email: Roland.Hedberg@umdac.umu.se
  264.         S: -200:3:         name: Roland Hedberg
  265.         S: -200:3:        title: Boss of the Network group
  266.         S: 200:Ok
  267.  
  268.    Commands that can apply to more than one field must have the name of
  269.    the field to which the response applies directly following the entry
  270.    index.
  271.  
  272.    The text of the response will be either an error message intended for
  273.    human consumption, or data from the Nameserver.  Whitespace (spaces
  274.    or tabs) may appear anywhere in the response, but the field name and
  275.    text columns if present must each begin with a whitespace character.
  276.  
  277.  
  278.  
  279.                                                                 [Page 5]
  280.  
  281. INTERNET DRAFT                                                  May 1997
  282.  
  283.  
  284.    Since more than one specific piece of information may be manipulated
  285.    by a particular command, it is possible for parts of a command to
  286.    succeed, while other parts of the same command fail.  This situation
  287.    is handled as a single multi-line response, with the result code
  288.    changing as appropriate.
  289.  
  290.    As for FTP, the result codes are in the range 100-699 (or from -699
  291.    to -100 for multiline responses), where the leading digit has the
  292.    following significance:
  293.  
  294.         1: In progress
  295.         2: Success
  296.         3: More information needed
  297.         4: Temporary failure; it may be worthwhile to try again.
  298.         5: Permanent failure
  299.         6: Phquery specific codes
  300.  
  301.    Many commands generate more than one line of response; every client
  302.    should be prepared to deal with such continued responses.  Note that
  303.    a command is finished when and only when the result code on a
  304.    response line (treated as a signed integer) is greater than or equal
  305.    to 200.
  306.  
  307.    Clients should not make any assumptions as to which numeric
  308.    responses, within the above mentioned ranges that are valid.  Also
  309.    note that the server is allowed to send one or more lines with
  310.    resultcodes between -199 - -100 and 100 - 199, as status information,
  311.    before the actual results are transmitted.
  312.  
  313. 2.3.  Format of a search string
  314.  
  315.    Matching is not sensitive to upper or lower case letters and is nor-
  316.    mally done on a word-by-word basis.  That is, both the query expres-
  317.    sion and the entry information is broken up into words, and indivi-
  318.    dual words are compared using exact matching.  If the order of the
  319.    words are important in a query, then the query string can be sur-
  320.    rounded by '"', whereby the complete search string is matched against
  321.    the information in the Nameserver database.
  322.  
  323.    Word delimiters are the following characters:  <SPACE>, <TAB>, <NEW-
  324.    LINE>, ",", ";" and ":" .  These characters are not indexed and
  325.    should not be part of the search string.
  326.  
  327.    However, special symbols, called "wildcard" characters, can be used
  328.    if the exact spelling is unknown.  The '*' (asterisk, 0x2A) is used
  329.    in place of zero or more characters, and '?' (question mark, 0x3F)
  330.    can be used when exactly one character is unknown.  If the unknown
  331.    character can be one of a limited set this can be specified by
  332.  
  333.  
  334.  
  335.                                                                 [Page 6]
  336.  
  337. INTERNET DRAFT                                                  May 1997
  338.  
  339.  
  340.    surrounding the set with brackets, e.g., [ei] means that in that
  341.    place a 'e' or a 'i' would match.
  342.  
  343. 3.  Commands
  344.  
  345. 3.1.  status
  346.  
  347.    status
  348.  
  349.    Prints the message of the day and the current status of the
  350.    nameserver.
  351.  
  352.         C: status
  353.         S: 100:Qi server $Revision: 3.1 $
  354.         S: 100:Ph passwords may be obtained at CCSO Accounting,
  355.         S: 100:1420 Digital Computer Lab, between 8:30 and 5 Monday-Friday.
  356.         S: 100:Be sure to bring your U of I ID card.
  357.         S: 200:Database ready
  358.  
  359. 3.2.  siteinfo
  360.  
  361.    siteonfo
  362.  
  363.    Returns information about the servers site.
  364.  
  365.    Version        Version information for the server.
  366.  
  367.    Maildomain     The mail domain to use for phquery-type mail.
  368.  
  369.    Mailfield      The field containing the specific email address.
  370.  
  371.    Mailbox        Mandatory entry that names the field to use as mail-
  372.                   drop.
  373.  
  374.    Administrator  Guru in charge of service.
  375.  
  376.    Passwords      Person in charge of ordinary password/change requests.
  377.  
  378.    Authenticate   Authentication methods supported by the server,
  379.                   ordered in the site-preferred way.  Presently the fol-
  380.                   lowing options are defined:
  381.                      1   attempt auto login
  382.                      2   allowed to be interactive if needed
  383.                      4   use ANSI X9.9 challenge/response
  384.                      8   use v4 Kerberos login
  385.                      16  use v5 Kerberos login
  386.                      32  use GSS-API login
  387.                      64  use email login
  388.  
  389.  
  390.  
  391.                                                                 [Page 7]
  392.  
  393. INTERNET DRAFT                                                  May 1997
  394.  
  395.  
  396.                      128 password encrypted response to challenge
  397.                      256 use clear-text password
  398.                      512 use HMAC (RFC-2104) with SHA-1 of challenge string
  399.  
  400.  
  401.         C: siteinfo
  402.         S: -200:1:version:3.1
  403.         S: -200:1:maildomain:umu.se
  404.         S: -200:2:mailfield:alias
  405.         S: -200:3:mailbox:email
  406.         S: -200:4:administrator:roland.hedberg@umdac.umu.se
  407.         S: -200:5:passwords:roland.hedberg@umdac.umu.se
  408.         S: -200:6:authenticate:64:32:128
  409.         S: 200: Ok.
  410.  
  411.    The mail fields in the siteinfo command direct how address informa-
  412.    tion stored in the Nameserver is to be used for delivering mail.
  413.  
  414.    The specific (username, host) pair to where a user's mail should be
  415.    sent for final delivery is stored in the field named by {mailbox}.
  416.    Phquery and like utilities will use this field.
  417.  
  418.    To construct a useable email address from Nameserver information, the
  419.    algorithm below is followed:
  420.  
  421.         if ({maildomain} is not null) then
  422.              address = (contents of {mailfield})@{maildomain}
  423.         else
  424.              address = (contents of {mailfield})
  425.  
  426.    N.B., Changing the value of {mailbox} to anything other than "email"
  427.    should not be done if {maildomain} is non-empty because extant refor-
  428.    matting clients will not do the right thing.  That is, if {mailbox}
  429.    is something other than "email", empty {maildomain} and do the
  430.    address reformatting on the server.
  431.  
  432. 3.3.  fields
  433.  
  434.    fields [field ...]
  435.  
  436.    Without an argument, a list of all available field descriptors should
  437.    be delivered.  Fields marked with the "LocalPub" property (Section
  438.    1.1.1) should not be delivered outside of the local domain.
  439.  
  440.    The output of the command consists of two lines describing each
  441.    field.  The first line defines the field in technical terms (max
  442.    length and field attributes), while the second line is a brief
  443.    description of what the field is intended to hold.  The second number
  444.  
  445.  
  446.  
  447.                                                                 [Page 8]
  448.  
  449. INTERNET DRAFT                                                  May 1997
  450.  
  451.  
  452.    of each response is the field id number.
  453.  
  454.         C: fields
  455.         S: -200:6:alias:max 32 Indexed Lookup Public Default
  456.         S: -200:6:alias:Unique name for user.
  457.         S: -200:3:name:max 64 Indexed Lookup Public Default
  458.         S: -200:3:name:Fullname
  459.         S: -200:2:email:max 128 Lookup Public Default
  460.         S: -200:2:email:Account to receive electronic mail.
  461.         S: -200:16:other:max 256 Lookup Public Default Change
  462.         S: -200:16:other:Other info the user finds important.
  463.         S: -200:33:home_phone:max 60 Lookup Public Change Turn
  464.         S: -200:33:home_phone:Home telephone number.
  465.         S: 200:Ok.
  466.  
  467. 3.4.  id
  468.  
  469.    id information
  470.  
  471.    Enters the given information in the Nameserver's log.  This command
  472.    is used by the Ph client to enter the user id of the person running
  473.    it.
  474.  
  475. 3.5.  set
  476.  
  477.  
  478.    set [option=[value] ...]
  479.  
  480.    Sets an option for this nameserver session.  Used without arguments
  481.    it return the settable options.
  482.  
  483.         C: set verbose=off
  484.         S: 200:Done.
  485.  
  486.         C: set
  487.         S: -200:echo:off
  488.         S: -200:limit:2
  489.         S: -200:characterset:iso-8859-1
  490.         S: -200:verbose:off
  491.         S: -200:addonly:off
  492.         S: -200:nolog:off
  493.         S: -200:external:on
  494.         S: 200:Done.
  495.  
  496. 3.6.  login, logout, answer, clear, email, and xlogin
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.                                                                 [Page 9]
  504.  
  505. INTERNET DRAFT                                                  May 1997
  506.  
  507.  
  508. 3.6.1.  login
  509.  
  510.    login [your-alias]
  511.  
  512.    The "login" command allows you to identify yourself to the
  513.    Nameserver.  More specifically, it identifies you with a particular
  514.    entry in the Nameserver and allows you to change the fields in that
  515.    entry and possibly other entries.  It is also necessary to be logged
  516.    in to the Nameserver to view certain sensitive fields in your own
  517.    entry.
  518.  
  519.    In order to use the "login" command, you must know both your ph alias
  520.    and your ph password.  The dialogue as it appears to the user:
  521.  
  522.         C: login foo
  523.         S: Enter nameserver password:
  524.         C: bar
  525.         S: 200:foo:Hi how are you?
  526.  
  527. 3.6.2.  logout
  528.  
  529.    logout
  530.  
  531.    The "logout" command allows a user who is logged in to the Nameserver
  532.    to logout.
  533.  
  534.         C: logout
  535.         S: 200:Ok.
  536.  
  537. 3.6.3.  answer
  538.  
  539.    answer encrypted-response
  540.  
  541.    In response to the login command, the Nameserver responds with a ran-
  542.    dom challenge string.  The Nameserver client encrypts the challenge
  543.    with the password supplied by the user and returns it in the "answer"
  544.    command:
  545.  
  546.         C: login ppomes
  547.         S: 301:.%$&.D^67$*1?<.2S@DR:Z@M*)AV-<:4QM>#R>M*HT
  548.         C: answer M5K'F:NI(a?M?O2+-a9`48RA#ZF=L9)G)7X$WGb`50B]
  549.         S: 200:ppomes:Hi how are you?
  550.  
  551.    The encryption algorithm is based on a three rotor Enigma engine.
  552.    There are known attacks on the security of this approach.
  553.  
  554.    The answer command is also used to return method-specific responses
  555.    to the xlogin command (section 3.6.6).
  556.  
  557.  
  558.  
  559.                                                                [Page 10]
  560.  
  561. INTERNET DRAFT                                                  May 1997
  562.  
  563.  
  564. 3.6.4.  clear
  565.  
  566.    clear cleartext-password
  567.  
  568.    The "clear" command can be used instead of the "answer" command to
  569.    complete a login sequence.  It's argument is the user's cleartext
  570.    password.  This command is supplied only to support those clients
  571.    that have not implemented one of the encryption engines used by the
  572.    "answer" command.  Availability of this command in the server is a
  573.    compile-time setting.  It's use is strongly discouraged.
  574.  
  575.         C: login ppomes
  576.         S: 301:E=@Y&VW^_9YVI;D5.[EB0:B)9Z#_&X$:2)\L$VJC87
  577.         C: clear MySecret
  578.         S: 200:ppomes:Hi how are you?
  579.  
  580. 3.6.5.  email
  581.  
  582.    email local-userid
  583.  
  584.    The "email" command can also be used instead of the "answer" command
  585.    to complete a login sequence.  The value of local-userid is the
  586.    user's login name on the local machine.  If all of the following con-
  587.    ditions are true, then the email command will be accepted by the
  588.    server:
  589.  
  590.    1)   The connection to the server originates on port 1023 or less on
  591.         the client.
  592.  
  593.    2)   The canonical name of the client's host matches the right-hand
  594.         side of the email address of the requested alias specified in
  595.         the "login" command.
  596.  
  597.    3)   The "local-userid" matches the left-hand side of the email
  598.         address belonging to the requested alias.
  599.  
  600.    This is a weak but convenient form of authentication.  Depending on
  601.    the information users are allowed to change about themselves and the
  602.    threat environment the server operates in, this method may be
  603.    appropriate.  Servers should take care to avoid DNS spoofing.
  604.  
  605. 3.6.6.  xlogin
  606.  
  607.    xlogin option alias
  608.  
  609.    Extended login command for GSS, Kerberos v4 and v5, ANSI X9.9 token
  610.    devices (e.g., SNK/4), etc.  The option is one of the values returned
  611.    in the Authenticate field of the "siteinfo" command (section 3.2).
  612.  
  613.  
  614.  
  615.                                                                [Page 11]
  616.  
  617. INTERNET DRAFT                                                  May 1997
  618.  
  619.  
  620.    Alias is the user's alias.
  621.  
  622.         C: xlogin 16 ppomes
  623.         S: 301:DoKrbLogin started; send Kerberos mutual authenticator.
  624.         C: answer Ja8QO1cJHYz2IdWyg7uhAnixVqgCZQBWr64ciXYku1ktdu....
  625.         S: 200:ppomes:Hi how are you?
  626.  
  627.         C: xlogin 4 ppomes
  628.         S: 302:SNK Challenge "024142":
  629.         C: answer 82344338
  630.         S: 200:ppomes:Hi how are you?
  631.  
  632.    The answer command returns the requested quantity, Kerberos authenti-
  633.    cator, X9.9 device response, etc.  Binary quantities are first base-
  634.    64 encoded.
  635.  
  636. 3.7.  add
  637.  
  638.    add field=value...
  639.  
  640.    This command is used to add new entries to the database.  You must be
  641.    logged in and have special privileges to use "add".
  642.  
  643.         C: add name="doe john" id="123456789" alias="j-doe"
  644.         S: 200:Ok.
  645.  
  646. 3.8.  query/ph
  647.  
  648.    query [field=]value [field=value] . . . [return field1 [field2]]
  649.  
  650.    If no field is specified together with a value then the field is
  651.    assumed to be "name" and/or "nickname".  When more than one field-
  652.    value specification are given in a query, entries matching all
  653.    specifications are returned (implicit AND).
  654.  
  655.    It is possible to define which fields should be returned by adding a
  656.    'return' clause.  If no return clause is defined the Ph server will
  657.    return a default list of fields.  A return clause consists of the
  658.    word "return" followed by a list of fields or the word "all".  If the
  659.    word "all" is used the all viewable fields will be returned.
  660.  
  661. 3.9.  delete
  662.  
  663.    delete [field=]value...
  664.  
  665.    This command is used to delete entire new entries from the database.
  666.    You must be logged in and have special privileges to use "delete".
  667.  
  668.  
  669.  
  670.  
  671.                                                                [Page 12]
  672.  
  673. INTERNET DRAFT                                                  May 1997
  674.  
  675.  
  676.    The arguments to the "delete" command are the same as the selection
  677.    part of a "query" command.  "Delete" finds all the entries that match
  678.    the argument(s) and deletes them.
  679.  
  680.    The "delete" command obeys the Nameserver "limit" option, which can
  681.    be used to prevent deletion of more entries than intended.
  682.  
  683. 3.10.  make
  684.  
  685.    make field="value"...
  686.  
  687.    The "make" command allows you to change fields in your own Nameserver
  688.    entry.  In order to use the "make" command, you must first login to
  689.    the Nameserver.
  690.  
  691. 3.11.  force
  692.  
  693.    force field="value"
  694.  
  695.    The "force" command overrides the encryption requirement for fields
  696.    such as password that have the Encrypt property.
  697.  
  698. 3.12.  change
  699.  
  700.    change [field=]value make field="value"...
  701.  
  702.    This command is used to change one or more fields to the values
  703.    specified.  The "change" command consists of two clauses, the
  704.    "change" clause and the "make" clause.  The "change" clause deter-
  705.    mines which entries will be affected by the command.  It uses the
  706.    same arguments as the selection clause of a "query" command.  The
  707.    "make" clause specifies which field(s) will be changed and the new
  708.    value(s) of the specified field(s).
  709.  
  710.    You must be logged in to use "change".
  711.  
  712.    Change differs from the "make" command in that it can modify multiple
  713.    Ph entries simultaneously.
  714.  
  715.    The "change" command obeys the Nameserver "limit" option, which can
  716.    be used to prevent changing the field contents of more entries than
  717.    intended.
  718.  
  719. 3.13.  help
  720.  
  721.    help [{native|client} [topic ...]]
  722.  
  723.    Prints help on the Nameserver as such or on specific clients .  If
  724.  
  725.  
  726.  
  727.                                                                [Page 13]
  728.  
  729. INTERNET DRAFT                                                  May 1997
  730.  
  731.  
  732.    client is specified, it should be a valid Nameserver client identif-
  733.    ier, such as "ph".  The client-specific help will first be searched
  734.    for topic, and then the native help will be searched.  If topic is
  735.    omitted, a list of all available help texts will be returned.  If
  736.    "native" or client are also omitted, a list of clients will be
  737.    returned.
  738.  
  739.         C: help native 101
  740.         S: 101:
  741.         S:  The Nameserver echo option is set. The text of this response
  742.         S:  is the command you just gave, which has not (yet) been executed.
  743.  
  744. 3.14.  quit/exit/stop
  745.  
  746.    quit
  747.  
  748.    Terminates the session with the Nameserver and causes the client to
  749.    exit.
  750.  
  751.         C: quit
  752.         S: 200:Bye!
  753.  
  754. 4.  Miscellaneous
  755.  
  756. 4.1.  4.1 Authors Addresses
  757.  
  758.    Roland Hedberg
  759.    Umdac
  760.    Umea University
  761.    901 87 Umea
  762.    Sweden
  763.    <Roland.Hedberg@umdac.umu.se>
  764.  
  765.    Paul Pomes
  766.    Qualcomm Inc
  767.    6455 Lusk Blvd
  768.    San Diego, CA
  769.    USA
  770.    <ppomes@qualcomm.com>
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.                                                                [Page 14]
  784.  
  785. INTERNET DRAFT                                                  May 1997
  786.  
  787.  
  788. Appendix A
  789.  
  790.    Default fields connected to different object types:
  791.  
  792.    type
  793.    name
  794.    address
  795.    write
  796.    password
  797.  
  798.    type=phone:   Information you would find in a phonebook
  799.    phone
  800.    fax
  801.  
  802.    type=person:  Information about a human being
  803.    alias
  804.    forename
  805.    surname
  806.    group
  807.    email
  808.    public_key
  809.    nickname
  810.    www
  811.    acl
  812.  
  813.    type=staff:   Information about an employee
  814.    empno
  815.    department
  816.    supervisor
  817.    secretary
  818.    office_location
  819.    office_address
  820.    office_phone
  821.    title
  822.    pager
  823.    hours
  824.  
  825.    type=unit:   Information about an organizational unit
  826.    email
  827.    www
  828.    public_key
  829.  
  830.  
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.  
  839.                                                                [Page 15]
  840.  
  841. INTERNET DRAFT                                                  May 1997
  842.  
  843.  
  844. Appendix B
  845.  
  846.    Result codes
  847.  
  848.    100 In progress (general).
  849.    101 Echo of current command.
  850.    102 Count of number of matches to query.
  851.    103 No hostname found for IP address.
  852.    200 Success (general).
  853.    201 Database ready, but read only.
  854.    300 More information (general).
  855.    301 Encrypt this string.
  856.    302 Print this prompt.
  857.    400 Temporary error (general).
  858.    401 Internal database error.
  859.    402 Lock not obtained within timeout period.
  860.    403 Login would have been OK, but database read-only
  861.    475 Database unavailable; try later.
  862.    500 Permanent error (general).
  863.    501 No matches to query.
  864.    502 Too many matches to query.
  865.    503 Not authorized for requested information.
  866.    504 Not authorized for requested search criteria.
  867.    505 Not authorized to change requested field.
  868.    506 Request refused; must be logged in to execute.
  869.    507 Field does not exist.
  870.    508 Field is not present in requested entry.
  871.    509 Alias already in use.
  872.    510 Not authorized to change this entry.
  873.    511 Not authorized to add entries.
  874.    512 Illegal value.
  875.    513 Unknown option.
  876.    514 Unknown command.
  877.    515 No indexed field in query.
  878.    516 No authorization for request.
  879.    517 Operation failed because database is read only.
  880.    518 To many entries selected by change command.
  881.    520 CPU usage limit exceeded.
  882.    521 Change command would have overridden existing field,
  883.    and the "addonly" option is on.
  884.    522 Attempt to view "Encrypted" field.
  885.    523 Expecting "answer" or "clear".
  886.    524 Names of help topics may not contain "/".
  887.    525 Email authentication failed
  888.    526 Host name address not found in DNS
  889.    527 Reverse DNS lookup does not match forward DNS lookup
  890.    528 General Kerberos database error.
  891.    529 Selected authentication method not available
  892.  
  893.  
  894.  
  895.                                                                [Page 16]
  896.  
  897. INTERNET DRAFT                                                  May 1997
  898.  
  899.  
  900.    590 Remote queries not allowed.
  901.    598 Command unknown.
  902.    599 Syntax error.
  903.    600 Ambiguous or multiple match
  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.                                                                [Page 17]
  952.  
  953. INTERNET DRAFT                                                  May 1997
  954.  
  955.  
  956. Appendix  C
  957.  
  958.    Description of the client command language using the augmented
  959.    Backus-Naur Form (RFC822).
  960.  
  961.    response = code:[index:][field:]text
  962.  
  963.    code     = [-] LDIG 2DIGIT
  964.    index    = 1*SPACE number
  965.    field    = 1*SPACE attribute
  966.    text     = 1*(CHAR / SPACE / HTAB )
  967.  
  968.  
  969.    command     = ph-command CRLF
  970.  
  971.    ph-command  =  "status" / a-command / oa-command
  972.    ph-command  =/ av-command / answer-command / query-command
  973.    ph-command  =/ delete-command / change-command / "help" / quit-command
  974.  
  975.    a-command       = ("siteinfo"/"fields"/"id"/"login"/"help"/"email"/
  976.               "clear") [attribute]
  977.    oa-command      = ("xlogin") number attribute
  978.    av-command      = ("set"/"add"/"make") 1*attribute-value
  979.    answer-command  = ("answer") 1*printable
  980.    query-command   = ("query"/"ph") 1*selection ["return" 1*attribute]
  981.    quit-command    = "quit" / "exit" / "stop"
  982.    change-command  = "change" 1*selection make 1*attribute-value
  983.    delete-command  = "delete" selection
  984.  
  985.    selection       = value / attribute-value
  986.  
  987.    attribute-value = attribute "=" value
  988.  
  989.    value           = 1*(cstring / quoted-string / SET)
  990.  
  991.    cstring         = 1*( ALPHA / DIGIT / S_SPEC / SET / qouted-pair )
  992.    attribute       = 1*( ALPHA / DIGIT / "_" / "-" )
  993.    number          = 1*(DIGIT)
  994.  
  995.    quoted-string   = <"> 1*(qtext/quoted-pair) <">
  996.  
  997.    quoted-pair  =  "
  998.    qtext        = 1*( CHAR / CR / SPEC1 / DELIMIT1 / DELIMIT2 / LWS )
  999.    set          = '[' 1*(ALPHA/DIGIT) ']'
  1000.  
  1001.    LWS          = 1*([CRLF] (SPACE / HTAB))
  1002.    CRLF         = CR LF
  1003.  
  1004.  
  1005.  
  1006.  
  1007.                                                                [Page 18]
  1008.  
  1009. INTERNET DRAFT                                                  May 1997
  1010.  
  1011.  
  1012.    S_SPEC       = '*'/'+'/'?'
  1013.    SPEC1        = "=" / "*" / "?" / "+" / "[" / "]"
  1014.    SPEC2        = "
  1015.    DELIMIT1     = SPACE / HTAB / LF
  1016.    DELIMIT2     = "," / ";" / ":"
  1017.    PRINTABLE    = %d32..%d126
  1018.    CTL          = %d0..%d31 / %d127..%d160
  1019.    ASCII        = DIGIT / ALPHA / OTHER
  1020.    ALPHA        = %d65..%d90 / %d97..%d122
  1021.    DIGIT        = %d48..%d57
  1022.    LDIG         = %d49..%d54
  1023.    SPACE        = %d32
  1024.    SEP          = (CR LF) / LF
  1025.    CR           = %d13
  1026.    LF           = %d10
  1027.    HTAB         = %d9
  1028.    CHAR         = %d33..%d126 / %d160..%d255
  1029.    OTHER        = "(" / ")" / "-" / "." / "/"
  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.                                                                [Page 19]
  1064.  
  1065. Expire in six months
  1066.