RFC 4156 HISTORIC URIS · HISTORIC

The wais URI Scheme

The URI forms used to identify WAIS databases, searches, and documents.

On rfc-editor.org ↗
PUBLISHED
August 2005
AUTHORS
P. Hoffman
STREAM
IETF
DEFAULT WAIS PORT
210
DOI
10.17487/RFC4156
ERRATA
Reported errata

RFC text

Contents
Original text · RFC Editor View on rfc-editor.org ↗
Network Working Group                                         P. Hoffman
Request for Comments: 4156                                VPN Consortium
Category: Historic                                           August 2005


                          The wais URI Scheme

Status of This Memo

   This memo defines a Historic Document for the Internet community.  It
   does not specify an Internet standard of any kind.  Distribution of
   this memo is unlimited.

Copyright Notice

   Copyright (C) The Internet Society (2005).

Abstract

   This document specifies the wais Uniform Resource Identifier (URI)
   scheme that was originally specified in RFC 1738.  The purpose of
   this document is to allow RFC 1738 to be made obsolete while keeping
   the information about the scheme on standards track.


1.  Introduction

   URIs were previously defined in RFC 2396 [RFC2396], which was updated
   by RFC 3986 [RFC3986].  Those documents also specify how to define
   schemes for URIs.

   The first definitions for many URI schemes appeared in RFC 1738
   [RFC1738].  Because that document has been made obsolete, this
   document copies the wais URI scheme from it to allow that material to
   remain on standards track.


2.  Scheme Definition

   The WAIS URL scheme is used to designate WAIS databases, searches, or
   individual documents available from a WAIS database.  The WAIS
   protocol is described in RFC 1625 [RFC1625].  Although the WAIS
   protocol is based on Z39.50-1988, the WAIS URL scheme is not intended
   for use with arbitrary Z39.50 services.

   Historical note: The WAIS protocol was not widely implemented and
   almost no WAIS servers are in use today.

   A WAIS URL takes one of the following forms:

      wais://<host>:<port>/<database>
      wais://<host>:<port>/<database>?<search>
      wais://<host>:<port>/<database>/<wtype>/<wpath>

   If :<port> is omitted, the port defaults to 210.  The first form
   designates a WAIS database that is available for searching.  The
   second form designates a particular search. <database> is the name of
   the WAIS database being queried.

   The third form designates a particular document, within a WAIS
   database, to be retrieved.  In this form <wtype> is the WAIS
   designation of the type of the object.  Many WAIS implementations
   require that a client know the "type" of an object prior to
   retrieval; the type is returned along with the internal object
   identifier in the search response.  The <wtype> is included in the
   URL in order to give the client interpreting the URL adequate
   information to actually retrieve the document.

   The <wpath> of a WAIS URL consists of the WAIS document-id.  The WAIS
   document-id should be treated opaquely; it may only be decomposed by
   the server that issued it.

3.  Security Considerations

   Many security considerations for URI schemes are discussed in
   [RFC3986].  There are no security considerations listed in [RFC1625],
   but it should be noted that there is no privacy nor authentication
   specified in the WAIS protocol.

4.  Informative References

   [RFC1738]  Berners-Lee, T., Masinter, L., and M. McCahill, "Uniform
              Resource Locators (URL)", RFC 1738, December 1994.

   [RFC2396]  Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
              Resource Identifiers (URI): Generic Syntax", RFC 2396,
              August 1998.

   [RFC3986]  Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
              Resource Identifier (URI): Generic Syntax", STD 66,
              RFC 3986, January 2005.

   [RFC1625]  St. Pierre, M., Fullton, J., Gamiel, K., Goldman, J.,
              Kahle, B., Kunze, J., Morris, H., and F. Schiettecatte,
              "WAIS over Z39.50-1988", RFC 1625, June 1994.

Author's Address

   Paul Hoffman
   VPN Consortium
   127 Segre Place
   Santa Cruz, CA  95060
   US

   EMail: paul.hoffman@vpnc.org

Full Copyright Statement

   Copyright (C) The Internet Society (2005).

   This document is subject to the rights, licenses and restrictions
   contained in BCP 78, and except as set forth therein, the authors
   retain all their rights.

   This document and the information contained herein are provided on an
   "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
   OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
   ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
   INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
   INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Intellectual Property

   The IETF takes no position regarding the validity or scope of any
   Intellectual Property Rights or other rights that might be claimed to
   pertain to the implementation or use of the technology described in
   this document or the extent to which any license under such rights
   might or might not be available; nor does it represent that it has
   made any independent effort to identify any such rights.  Information
   on the procedures with respect to rights in RFC documents can be
   found in BCP 78 and BCP 79.

   Copies of IPR disclosures made to the IETF Secretariat and any
   assurances of licenses to be made available, or the result of an
   attempt made to obtain a general license or permission for the use of
   such proprietary rights by implementers or users of this
   specification can be obtained from the IETF on-line IPR repository at
   http://www.ietf.org/ipr.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights that may cover technology that may be required to implement
   this standard.  Please address the information to the IETF at ietf-
   ipr@ietf.org.

Acknowledgement

   Funding for the RFC Editor function is currently provided by the
   Internet Society.

ISO Plain Language

On this page
PROBLEMThe definition of the wais URI scheme was in RFC 1738, which was being made obsolete while information about the scheme needed to be retained.
MECHANISMThe RFC records three wais URL forms for databases, searches, and documents, including the default port when it is omitted.
THE HISTORICAL STATUSThe document preserves the scheme definition and notes that WAIS was not widely implemented and almost no servers were in use at publication; the unit marks it Historic.

§1Why the Scheme Was Recorded Again

Many URI schemes were first defined in RFC 1738. Because that document had become obsolete, RFC 4156 copies the wais scheme definition so information about it remains available.

The RFC describes the scheme as identifying WAIS databases, searches, and individual documents in a WAIS database. It says the scheme is not intended for arbitrary Z39.50 services.

This RFC preserves the wais address format after its earlier source document became obsolete. The format identifies resources offered through WAIS.

§2Three Forms of a WAIS URI

A wais URI can name a database, a specific search in that database, or a particular document. The document form includes the WAIS object type and an opaque document identifier that only the server that issued it can interpret.

If the port is omitted, the default is 210. The type in a document URI gives the client information that some WAIS implementations require to retrieve the object.

The address can point to a database, a search, or one document. The document identifier is for the WAIS server to interpret, not for clients to take apart.

§2Security and Historical Context

The RFC says the WAIS protocol specifies neither privacy nor authentication. It also notes that the protocol was not widely implemented and that almost no WAIS servers were in use at the time of writing.

The unit metadata marks this document Historic. RFC 4156 records the URI syntax rather than defining a new WAIS protocol.

The URI scheme does not add privacy or authentication to WAIS. The RFC records a historical format for a protocol that had little deployment at the time.