From: mike Date: Thu, 13 Dec 2012 20:29:45 +0000 (+0000) Subject: Drop CUPS browsing document (STR #4234) X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a7a1fcdb31ae728846142a6a41688f6151ff5c17;p=thirdparty%2Fcups.git Drop CUPS browsing document (STR #4234) git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@10763 7a7537e8-13f0-0310-91df-b6672ffda945 --- diff --git a/CHANGES-1.6.txt b/CHANGES-1.6.txt index fee1be4d45..3f64ee5455 100644 --- a/CHANGES-1.6.txt +++ b/CHANGES-1.6.txt @@ -3,7 +3,7 @@ CHANGES-1.6.txt CHANGES IN CUPS V1.6.2 - - Documentation fixes (STR #4239) + - Documentation fixes (STR #4239, STR #4234) - Security: All file, directory, user, and group settings are now stored in a separate cups-files.conf configuration file that cannot be set through the CUPS web interface or APIs (STR #4223) diff --git a/doc/Makefile b/doc/Makefile index 939ea14330..b6af04c1fa 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -116,7 +116,6 @@ HELPFILES = \ help/security.html \ help/sharing.html \ help/spec-banner.html \ - help/spec-browsing.html \ help/spec-cmp.html \ help/spec-command.html \ help/spec-design.html \ diff --git a/doc/help/spec-browsing.html b/doc/help/spec-browsing.html deleted file mode 100644 index 92c0259ee2..0000000000 --- a/doc/help/spec-browsing.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - CUPS Browse Protocol - - - - - - -

Note: - -
The CUPS Browse Protocol is deprecated and will no longer be used in a future release of CUPS.
- -

- -

CUPS Browse Protocol

- -

Introduction

- -

This specification describes the CUPS browsing protocol which is used for -printer sharing. The protocol is a UDP/IP-based broadcast service that -operates on IP service port 631 by default. Each broadcast packet describes -a single printer or class being shared.

- -

For simple networks with a single subnet, a CUPS system sharing a printer -(the server) will periodically broadcast that printer's availability -and status information to the subnet. Every other CUPS system on the subnet -(the clients) will receive the broadcast and make that printer -available to local users. If a client stops receiving broadcasts from the -server, or if the server sends a special "deleted" broadcast message, the -client will remove its copy of the printer.

- -

For larger networks with multiple subnets, a relay configuration can be used -where one or more client systems poll the server and then broadcast the -availability and status information for the server's shared printers to the -clients' local subnets.

- -

A key feature of CUPS printer sharing is support for implicit -classes, which are automatically-created classes for printers that are -shared by multiple servers. These implicit classes provide automatic load -balancing and fail-safe printing functionality transparently to the user.

- - -

Security Considerations

- -

Like most discovery protocols, CUPS browse packets are not encrypted or -signed, so it is possible for malicious systems on a network to advertise -or remove printers on that network to cause denial of service or information -disclosure. In order to combat this, CUPS logs incoming browse packets and -provides access controls to limit browse packet reception to known hosts.

- - -

Browse Packet Format

- -

Each broadcast packet is an ASCII text string of up to 1450 bytes ending -with a line feed (0x0a). The general format is:

- -

-printer-type printer-state printer-uri "printer-location" "printer-info" -"printer-make-and-model" name=value name2=value2 ... -

- -

Each of the fields contains the value of the corresponding IPP attribute. -The trailing "name=value" information is used to convey default job template -attribute values (job-sheets-default, media-default, etc.), authentication -requirements (auth-info-required), and additional IPP URI options that are -requested by the server (ipp-options).

- -

ABNF Definition

- -

The following ABNF definition [RFC4234, RFC3986] defines the format of each -browse packet:

- -

-PACKET         = TYPE WSP STATE WSP URI WSP LOCATION WSP INFO WSP
-                 MAKE-AND-MODEL WSP *[ WSP ATTR-NAME "=" ATTR-VALUE ] LF
-
-TYPE           = 1*HEXDIG
-
-STATE          = "3" / "4" / "5"
-
-URI            = "ipp://" ( 1*NAMECHAR / IP-literal / IPv4address )
-                 [ ":" 1*DIGIT ] ( "/printers/" / "/classes/" ) 1*NAMECHAR
-NAMECHAR       = %x21.22.24.26-2E.30-7E / %x25 HEXDIG HEXDIG
-IP-literal     = See RFC 3986
-IPv4address    = See RFC 3986
-
-LOCATION       = QUOTED-STRING
-INFO           = QUOTED-STRING
-MAKE-AND-MODEL = QUOTED-STRING
-
-ATTR-NAME      = 1*( ALPHA / DIGIT / "-" / "." )
-ATTR-VALUE     = QUOTED-STRING / 1*UNQUOTE-CHAR
-
-QUOTED-STRING  = DQUOTE *QUOTED-CHAR DQUOTE
-QUOTED-CHAR    = %x20.21.23-5B.5D-7E / UTF8-CHAR / %x5C %x5C / %x5C %x22
-UNQUOTE-CHAR   = %x21.23-26.28-5B.5D-7E / UTF8-CHAR
-UTF8-CHAR      = %xC0.DF %x80.BF / %xE0.EF %x80.BF %x80.BF /
-                 %xF0.F7 %x80.BF %x80.BF %x80.BF
-

- - -