draft-ietf-ipp-protocol-03.txt   draft-ietf-ipp-protocol-04.txt 
INTERNET-DRAFT INTERNET-DRAFT Robert Herriot (editor)
Robert Herriot (editor)
Sun Microsystems Sun Microsystems
Sylvan Butler <draft-ietf-ipp-protocol-04.txt> Sylvan Butler
Hewlett-Packard Hewlett-Packard
Paul Moore Paul Moore
Microsoft. Microsoft
Randy Turner Randy Turner
Sharp Labs Sharp Labs
November 7, 1997 December 19, 1997
Internet Printing Protocol/1.0: Protocol Specification Internet Printing Protocol/1.0: Protocol Specification
draft-ietf-ipp-protocol-03.txt
Copyright c The Internet Society (date). All Rights Reserved.
Status of this Memo Status of this Memo
This document is an Internet-Draft. Internet-Drafts are working This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas, and documents of the Internet Engineering Task Force (IETF), its areas, and
its working groups. Note that other groups may also distribute working its working groups. Note that other groups may also distribute working
documents as Internet-Drafts. documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference material time. It is inappropriate to use Internet-Drafts as reference material
or to cite them other than as "work in progress". or to cite them other than as "work in progress".
To learn the current status of any Internet-Draft, please check the To learn the current status of any Internet-Draft, please check the
"1id-abstracts.txt" listing contained in the Internet-Drafts Shadow "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow
Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe), Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or
ftp.isi.edu (US West Coast). ftp.isi.edu (US West Coast).
Copyright Notice
Copyright (C)The Internet Society (1997). All Rights Reserved.
Abstract Abstract
This document is one of a set of documents, which together describe all This document is one of a set of documents, which together describe all
aspects of a new Internet Printing Protocol (IPP). IPP is an aspects of a new Internet Printing Protocol (IPP). IPP is an
application level protocol that can be used for distributed printing application level protocol that can be used for distributed printing
using Internet tools and technology. The protocol is heavily influenced using Internet tools and technology. The protocol is heavily influenced
by the printing model introduced in the Document Printing Application by the printing model introduced in the Document Printing Application
(ISO/IEC 10175 DPA) standard [dpa]. Although DPA specifies both end (ISO/IEC 10175 DPA) standard [dpa]. Although DPA specifies both end
user and administrative features, IPP version 1.0 is focused only on end user and administrative features, IPP version 1.0 is focused only on end
user functionality. user functionality.
The full set of IPP documents includes: The full set of IPP documents includes:
Requirements for an Internet Printing Protocol [ipp-req] Requirements for an Internet Printing Protocol [ipp-req]
Internet Printing Protocol/1.0: Model and Semantics [ipp-mod] Internet Printing Protocol/1.0: Model and Semantics [ipp-mod]
Internet Printing Protocol/1.0: Protocol Specification (this Internet Printing Protocol/1.0: Protocol Specification (this
document) document)
Moore and Turner Expires June 19, 1998
The requirements document takes a broad look at distributed printing The requirements document takes a broad look at distributed printing
functionality, and it enumerates real-life scenarios that help to functionality, and it enumerates real-life scenarios that help to
clarify the features that need to be included in a printing protocol for clarify the features that need to be included in a printing protocol for
the Internet. It identifies requirements for three types of users: end the Internet. It identifies requirements for three types of users: end
Moore and Turner Expires May 7, 1998
users, operators, and administrators. The requirements document calls users, operators, and administrators. The requirements document calls
out a subset of end user requirements that MUST be satisfied in the out a subset of end user requirements that MUST be satisfied in the
first version of IPP. Operator and administrator requirements are out first version of IPP. Operator and administrator requirements are out
of scope for v1.0. The model and semantics document describes a of scope for v1.0. The model and semantics document describes a
simplified model with abstract objects, their attributes, and their simplified model with abstract objects, their attributes, and their
operations. The model introduces a Printer object and a Job object. The operations. The model introduces a Printer object and a Job object. The
Job object supports multiple documents per job. The protocol Job object supports multiple documents per job. The protocol
specification is formal document which incorporates the ideas in all the specification is formal document which incorporates the ideas in all the
other documents into a concrete mapping using clearly defined data other documents into a concrete mapping using clearly defined data
representations and transport protocol mappings that real implementers representations and transport protocol mappings that real implementers
skipping to change at page 3, line 5 skipping to change at page 3, line 5
Specification'' document. Specification'' document.
Notice Notice
The IETF invites any interested party to bring to its attention any The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary rights copyrights, patents or patent applications, or other proprietary rights
which may cover technology that may be required to practice this which may cover technology that may be required to practice this
standard. Please address the information to the IETF Executive standard. Please address the information to the IETF Executive
Director. Director.
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
Table of Contents Table of Contents
1. Introduction........................................................4 1. Introduction........................................................4
2. Conformance Terminology.............................................4 2. Conformance Terminology.............................................4
3. Encoding of the Operation Layer....................................4 3. Encoding of the Operation Layer....................................4
3.1 Picture of the Encoding.........................................5 3.1 Picture of the Encoding.........................................5
3.2 Syntax of Encoding..............................................6 3.2 Syntax of Encoding..............................................7
3.3 Version.........................................................8 3.3 Version.........................................................8
3.4 Mapping of Operations...........................................8 3.4 Mapping of Operations...........................................8
3.5 Mapping of Status-code..........................................8 3.5 Mapping of Status-code..........................................8
3.6 Tags............................................................. 3.6 Request-id......................................................9
3.6.1 Delimiter Tags.............................................8 3.7 Tags.............................................................
3.6.2 Value Tags.................................................9 3.7.1 Delimiter Tags.............................................9
3.7 Name-Lengths...................................................11 3.7.2 Value Tags................................................10
3.8 Mapping of Attribute Names....................................11 3.8 Name-Lengths...................................................12
3.9 Value Lengths..................................................12 3.9 Mapping of Attribute Names....................................12
3.10 Mapping of Attribute Values...................................12 3.10 Value Lengths.................................................13
3.11 Data............................................................ 3.11 Mapping of Attribute Values...................................13
4. Encoding of Transport Layer........................................14 3.12 Data............................................................
4.1 General Headers................................................15 4. Encoding of Transport Layer........................................15
4.2 Request Headers...............................................16 4.1 General Headers................................................16
4.3 Response Headers...............................................16 4.2 Request Headers...............................................17
4.4 Entity Headers................................................17 4.3 Response Headers...............................................18
5. Security Considerations............................................17 4.4 Entity Headers................................................18
6. Copyright..........................................................18 5. Security Considerations............................................19
7. References.........................................................19 6. References.........................................................19
8. Author's Address...................................................20 7. Author's Address...................................................21
9. Other Participants:................................................20 8. Other Participants:................................................21
10. Appendix A: Protocol Examples.....................................21 9. Appendix A: Protocol Examples......................................22
10.1 Print-Job Request.............................................21 9.1 Print-Job Request..............................................22
10.2 Print-Job Response (successful)...............................22 9.2 Print-Job Response (successful)................................23
10.3 Print-Job Response (failure)..................................23 9.3 Print-Job Response (failure)...................................24
10.4 Print-URI Request.............................................24 9.4 Print-URI Request..............................................25
10.5 Create-Job Request............................................25 9.5 Create-Job Request.............................................25
10.6 Get-Jobs Request..............................................25 9.6 Get-Jobs Request...............................................26
10.7 Get-Jobs Response.............................................26 9.7 Get-Jobs Response..............................................27
11. Appendix B: Mapping of Each Operation in the Encoding.............27 10. Appendix B: Hints to implementors using IPP with SSL3.............28
12. Appendix C: Hints to implementors using IPP with SSL3.............32 11. Appendix C: Registration of MIME Media Type Information for
"application/ipp".....................................................29
12. Appendix D: Full Copyright Statement..............................31
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
1. Introduction 1. Introduction
This document contains the rules for encoding IPP operations and This document contains the rules for encoding IPP operations and
describes two layers: the transport layer and the operation layer. describes two layers: the transport layer and the operation layer.
The transport layer consists of an HTTP/1.1 request or response. RFC The transport layer consists of an HTTP/1.1 request or response. RFC
2068 [rfc2068] describes HTTP/1.1. This document specifies the HTTP 2068 [rfc2068] describes HTTP/1.1. This document specifies the HTTP
headers that an IPP implementation supports. headers that an IPP implementation supports.
skipping to change at page 4, line 32 skipping to change at page 4, line 32
2. Conformance Terminology 2. Conformance Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [rfc2119]. document are to be interpreted as described in RFC 2119 [rfc2119].
3. Encoding of the Operation Layer 3. Encoding of the Operation Layer
The operation layer SHALL contain a single operation request or The operation layer SHALL contain a single operation request or
operation response. operation response. Each request or response consists of a sequence of
values and attribute groups. Attribute groups consist of a sequence of
attributes each of which is a name and value. Names and values are
ultimately sequences of octets
The encoding consists of octets as the most primitive type. There are The encoding consists of octets as the most primitive type. There are
several types built from octets, but three important types are several types built from octets, but three important types are
integers, character strings and octet strings, on which most other integers, character strings and octet strings, on which most other
data types are built. Every character string in this encoding SHALL be a data types are built. Every character string in this encoding SHALL be a
sequence of characters where the characters are associated with some sequence of characters where the characters are associated with some
charset and some natural language. . A character string MUST be in charset and some natural language. . A character string MUST be in
"network byte order" with the first character in the value (according to "reading order" with the first character in the value (according to
reading order) being the first character in the encoding. A character reading order) being the first character in the encoding. A character
string whose associated charset is US-ASCII whose associated natural string whose associated charset is US-ASCII whose associated natural
language is US English is henceforth called a US-ASCII-STRING. A language is US English is henceforth called a US-ASCII-STRING. A
character string whose associated charset and natural language are character string whose associated charset and natural language are
specified in a request or response as described in the model document is specified in a request or response as described in the model document is
henceforth called a LOCALIZED-STRING. . An octet string MUST be in henceforth called a LOCALIZED-STRING. An octet string MUST be in "IPP
"network byte order" with the first octet in the value (according to model document order" with the first octet in the value (according to
reading order) being the first octet in the encoding Every integer in the IPP model document order) being the first octet in the encoding
this encoding SHALL be encoded as a signed integer using two's- Every integer in this encoding SHALL be encoded as a signed integer
complement binary encoding with big-endian format (also known as using two's-complement binary encoding with big-endian format (also
"network order" and "most significant byte first"). The number of octets known as "network order" and "most significant byte first"). The number
for an integer SHALL be 1, 2 or 4, depending on usage in the protocol. of octets for an integer SHALL be 1, 2 or 4, depending on usage in the
Such one-octet integers, henceforth called SIGNED-BYTE, are used for the protocol. Such one-octet integers, henceforth called SIGNED-BYTE, are
version and tag fields. Such two-byte integers, henceforth called used for the version and tag fields. Such two-byte integers, henceforth
SIGNED-SHORT are used for the operation, status-code and length fields.
Four byte integers, henceforth called SIGNED-INTEGER, are used for
values fields.
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
called SIGNED-SHORT are used for the operation, status-code and length
fields. Four byte integers, henceforth called SIGNED-INTEGER, are used
for values fields and the sequence number.
The following two sections present the operation layer in two ways The following two sections present the operation layer in two ways
. informally through pictures and description . informally through pictures and description
. formally through Augmented Backus-Naur Form (ABNF), as specified by . formally through Augmented Backus-Naur Form (ABNF), as specified by
draft-ietf-drums-abnf-02.txt [abnf] RFC 2234 [rfc2234]
3.1 Picture of the Encoding 3.1 Picture of the Encoding
The encoding for an operation request or response consists of: The encoding for an operation request or response consists of:
----------------------------------------------- -----------------------------------------------
| version | 2 bytes - required | version | 2 bytes - required
----------------------------------------------- -----------------------------------------------
|operation (request) or status-code (response)| 2 bytes - required |operation (request) or status-code (response)| 2 bytes - required
-----------------------------------------------
| request-id | 4 bytes - required
----------------------------------------------------------- -----------------------------------------------------------
| xxx-attributes-tag | 1 byte | | xxx-attributes-tag | 1 byte |
----------------------------------------------- |-0 or more ----------------------------------------------- |-0 or more
| xxx-attribute-sequence | n bytes | | xxx-attribute-sequence | n bytes |
----------------------------------------------------------- -----------------------------------------------------------
| data-tag | 1 byte - required | end-of-attributes-tag | 1 byte - required
----------------------------------------------- -----------------------------------------------
| data | q bytes - optional | data | q bytes - optional
----------------------------------------------- -----------------------------------------------
The xxx-attributes-tag and xxx-attribute-sequence represents four The xxx-attributes-tag and xxx-attribute-sequence represents four
different values of "xxx", namely, operation, job, printer and different values of "xxx", namely, operation, job, printer and
unsupported-job. The xxx-attributes-tag and xxx-attribute-sequence may unsupported. The xxx-attributes-tag and an xxx-attribute-sequence
be omitted if the operation has no attributes or it may be repeated with represent attribute groups in the model document. The xxx-attributes-tag
the same or different values of "xxx" in ways that are specific to each identifies the attribute group and the xxx-attribute-sequence contains
operation. The data is omitted from some operations, but the data-tag is the attributes.
present even when the data is omitted. Note, the xxx-attributes-tags and
data-tag are called `delimiter-tags'.
Note: the xxx-attribute-sequence, shown above may consist of 0 bytes, The expected sequence of xxx-attributes-tag and xxx-attribute-sequence
according to the rule below. is specified in the IPP model document for each operation request and
operation response.
A request or response SHOULD contain each xxx-attributes-tag defined for
that request or response even if there are no attributes except for the
unsupported-attributes-tag which SHOULD be present only if the
unsupported-attribute-sequence is non-empty. A receiver of a request
SHALL be able to process as equivalent empty attribute groups:
a) an xxx-attributes-tag with an empty xxx-attribute-sequence,
b) an expected but missing xxx-attributes-tag.
The data is omitted from some operations, but the end-of-attributes-tag
is present even when the data is omitted. Note, the xxx-attributes-tags
Moore and Turner Expires June 19, 1998
and end-of-attributes-tag are called `delimiter-tags'. Note: the xxx-
attribute-sequence, shown above may consist of 0 bytes, according to the
rule below.
An xxx-attributes-sequence consists of zero or more compound-attributes. An xxx-attributes-sequence consists of zero or more compound-attributes.
----------------------------------------------- -----------------------------------------------
| compound-attribute | s bytes - 0 or more | compound-attribute | s bytes - 0 or more
----------------------------------------------- -----------------------------------------------
A compound-attribute consists of an attribute with a single value A compound-attribute consists of an attribute with a single value
followed by zero or more additional values. followed by zero or more additional values.
Note: a `compound-attribute' represents a single attribute in the model Note: a `compound-attribute' represents a single attribute in the model
document. The `additional value' syntax is for attributes with 2 or document. The `additional value' syntax is for attributes with 2 or
more values. more values.
Each attribute consists of: Each attribute consists of:
Moore and Turner Expires May 7, 1998
----------------------------------------------- -----------------------------------------------
| value-tag | 1 byte | value-tag | 1 byte
----------------------------------------------- -----------------------------------------------
| name-length (value is u) | 2 bytes | name-length (value is u) | 2 bytes
----------------------------------------------- -----------------------------------------------
| name | u bytes | name | u bytes
----------------------------------------------- -----------------------------------------------
| value-length (value is v) | 2 bytes | value-length (value is v) | 2 bytes
----------------------------------------------- -----------------------------------------------
| value | v bytes | value | v bytes
skipping to change at page 6, line 34 skipping to change at page 7, line 5
----------------------------------------------- |-0 or more ----------------------------------------------- |-0 or more
| value-length (value is w) | 2 bytes | | value-length (value is w) | 2 bytes |
----------------------------------------------- | ----------------------------------------------- |
| value | w bytes | | value | w bytes |
----------------------------------------------------------- -----------------------------------------------------------
Note: an additional value is like an attribute whose name-length is 0. Note: an additional value is like an attribute whose name-length is 0.
From the standpoint of a parsing loop, the encoding consists of: From the standpoint of a parsing loop, the encoding consists of:
Moore and Turner Expires June 19, 1998
----------------------------------------------- -----------------------------------------------
| version | 2 bytes - required | version | 2 bytes - required
----------------------------------------------- -----------------------------------------------
|operation (request) or status-code (response)| 2 bytes - required |operation (request) or status-code (response)| 2 bytes - required
-----------------------------------------------
| request-id | 4 bytes - required
----------------------------------------------------------- -----------------------------------------------------------
| tag (delimiter-tag or value-tag) | 1 byte | | tag (delimiter-tag or value-tag) | 1 byte |
----------------------------------------------- |-0 or more ----------------------------------------------- |-0 or more
| empty or rest of attribute | x bytes | | empty or rest of attribute | x bytes |
----------------------------------------------------------- -----------------------------------------------------------
| data-tag | 2 bytes - required | end-of-attributes-tag | 2 bytes - required
----------------------------------------------- -----------------------------------------------
| data | y bytes - optional | data | y bytes - optional
----------------------------------------------- -----------------------------------------------
The value of the tag determines whether the bytes following the tag are: The value of the tag determines whether the bytes following the tag are:
. attributes . attributes
. data . data
. the remainder of a single attribute where the tag specifies the . the remainder of a single attribute where the tag specifies the
type of the value. type of the value.
3.2 Syntax of Encoding 3.2 Syntax of Encoding
The syntax below is ABNF [abnf] except `strings of literals' SHALL be The syntax below is ABNF [rfc2234] except `strings of literals' SHALL be
case sensitive. For example `a' means lower case `a' and not upper case case sensitive. For example `a' means lower case `a' and not upper case
Moore and Turner Expires May 7, 1998
`A'. In addition, SIGNED-BYTE and SIGNED-SHORT fields are represented `A'. In addition, SIGNED-BYTE and SIGNED-SHORT fields are represented
as `%x' values which show their range of values. as `%x' values which show their range of values.
ipp-message = ipp-request / ipp-response ipp-message = ipp-request / ipp-response
ipp-request = version operation ipp-request = version operation request-id
*(xxx-attributes-tag xxx-attribute-sequence) data-tag data *(xxx-attributes-tag xxx-attribute-sequence) end-of-
ipp-response = version status-code attributes-tag data
*(xxx-attributes-tag xxx-attribute-sequence) data-tag data ipp-response = version status-code request-id
*(xxx-attributes-tag xxx-attribute-sequence) end-of-
attributes-tag data
xxx-attribute-sequence = *compound-attribute xxx-attribute-sequence = *compound-attribute
; where "xxx" in the three rules above stands for any of the
following xxx-attributes-tag = operation-attributes-tag / job-attributes-tag /
; values: "operation", "job", "printer" or "unsupported-job". printer-attributes-tag / unsupported-attributes-tag
version = major-version minor-version version = major-version minor-version
major-version = SIGNED-BYTE ; initially %d1 major-version = SIGNED-BYTE ; initially %d1
minor-version = SIGNED-BYTE ; initially %d0 minor-version = SIGNED-BYTE ; initially %d0
operation = SIGNED-SHORT ; mapping from model defined below operation = SIGNED-SHORT ; mapping from model defined below
status-code = SIGNED-SHORT ; mapping from model defined below status-code = SIGNED-SHORT ; mapping from model defined below
compound-attribute = attribute *additional-values compound-attribute = attribute *additional-values
attribute = value-tag name-length name value-length value attribute = value-tag name-length name value-length value
additional-values = value-tag zero-name-length value-length value additional-values = value-tag zero-name-length value-length value
Moore and Turner Expires June 19, 1998
name-length = SIGNED-SHORT ; number of octets of `name' name-length = SIGNED-SHORT ; number of octets of `name'
name = LALPHA *( LALPHA / DIGIT / "-" / "_" / "." ) name = LALPHA *( LALPHA / DIGIT / "-" / "_" / "." )
value-length = SIGNED-SHORT ; number of octets of `value' value-length = SIGNED-SHORT ; number of octets of `value'
value = OCTET-STRING value = OCTET-STRING
data = OCTET-STRING data = OCTET-STRING
zero-name-length = %x00.00 ; name-length of 0 zero-name-length = %x00.00 ; name-length of 0
operation-attributes-tag = %x01 ; tag of 1 operation-attributes-tag = %x01 ; tag of 1
job-attributes-tag = %x02 ; tag of 2 job-attributes-tag = %x02 ; tag of 2
printer-attributes-tag = %x04 ; tag of 4 printer-attributes-tag = %x04 ; tag of 4
unsupported-job-attributes-tag = %x05 ; tag of 5 unsupported- attributes-tag = %x05 ; tag of 5
data-tag = %x03 ; end-of-attributes-tag = %x03 ; tag of 3
tag of 3
value-tag = %x10-FF value-tag = %x10-FF
SIGNED-BYTE = BYTE SIGNED-BYTE = BYTE
SIGNED-SHORT = 2BYTE SIGNED-SHORT = 2BYTE
DIGIT = %x30-39 ; "0" to "9" DIGIT = %x30-39 ; "0" to "9"
LALPHA = %x61-7A ; "a" to "z" LALPHA = %x61-7A ; "a" to "z"
BYTE = %x00-FF BYTE = %x00-FF
OCTET-STRING = *BYTE OCTET-STRING = *BYTE
The syntax allows an xxx-attributes-tag to be present when the xxx- The syntax allows an xxx-attributes-tag to be present when the xxx-
attribute-sequence that follows is empty. The syntax is defined this way attribute-sequence that follows is empty. The syntax is defined this way
to allow for the response of Get-Jobs where no attributes are returned to allow for the response of Get-Jobs where no attributes are returned
for some job-objects. Although it is RECOMMENDED that the sender not for some job-objects. Although it is RECOMMENDED that the sender not
send an xxx-attributes-tag if there are no attributes (except in the send an xxx-attributes-tag if there are no attributes (except in the
Moore and Turner Expires May 7, 1998
Get-Jobs response just mentioned), the receiver MUST be able to decode Get-Jobs response just mentioned), the receiver MUST be able to decode
such syntax. such syntax.
3.3 Version 3.3 Version
The version SHALL consist of a major and minor version, each of which The version SHALL consist of a major and minor version, each of which
SHALL be represented by a SIGNED-BYTE. The protocol described in this SHALL be represented by a SIGNED-BYTE. The protocol described in this
document SHALL have a major version of 1 (0x01) and a minor version of document SHALL have a major version of 1 (0x01) and a minor version of
0 (0x00). The ABNF for these two bytes SHALL be %x01.00. 0 (0x00). The ABNF for these two bytes SHALL be %x01.00.
skipping to change at page 8, line 29 skipping to change at page 9, line 5
Operations are defined as enums in the model document. An operations Operations are defined as enums in the model document. An operations
enum value SHALL be encoded as a SIGNED-SHORT enum value SHALL be encoded as a SIGNED-SHORT
Note: the values 0x4000 to 0xFFFF are reserved for private extensions. Note: the values 0x4000 to 0xFFFF are reserved for private extensions.
3.5 Mapping of Status-code 3.5 Mapping of Status-code
Status-codes are defined as enums in the model document. A status-code Status-codes are defined as enums in the model document. A status-code
enum value SHALL be encoded as a SIGNED-SHORT enum value SHALL be encoded as a SIGNED-SHORT
Moore and Turner Expires June 19, 1998
The status-code is an operation attribute in the model document. In the
protocol, the status-code is in a special position, outside of the
operation attributes.
If an IPP status-code is returned, then the HTTP Status-Code MUST be 200 If an IPP status-code is returned, then the HTTP Status-Code MUST be 200
(OK). With any other HTTP Status-Code value, the HTTP response SHALL NOT (OK). With any other HTTP Status-Code value, the HTTP response SHALL NOT
contain an IPP message-body, and thus no IPP status-code is returned. contain an IPP message-body, and thus no IPP status-code is returned.
3.6 Tags 3.6 Request-id
The request-id allows a client to match a response with a request. This
mechanism is unnecessary in HTTP, but may be useful when application/ipp
entity bodies are used in another context.
The request-id in a response SHALL be the value of the request-id
received in the corresponding request. A client can set the request-id
in each request to a unique value or a constant value, such as 1,
depending on what the client does with the request-id returned in the
response.
3.7 Tags
There are two kinds of tags: There are two kinds of tags:
. delimiter tags: delimit major sections of the protocol, namely . delimiter tags: delimit major sections of the protocol, namely
attributes and data attributes and data
. value tags: specify the type of each attribute value . value tags: specify the type of each attribute value
3.6.1 Delimiter Tags 3.7.1 Delimiter Tags
The following table specifies the values for the delimiter tags: The following table specifies the values for the delimiter tags:
Tag Value (Hex) Delimiter Tag Value (Hex) Delimiter
0x00 reserved 0x00 reserved
0x01 operation-attributes-tag 0x01 operation-attributes-tag
0x02 job-attributes-tag 0x02 job-attributes-tag
0x03 data-tag 0x03 end-of-attributes-tag
0x04 printer-attributes-tag 0x04 printer-attributes-tag
0x05 unsupported-job-attributes-tag 0x05 unsupported-attributes-tag
0x06-0x0F reserved for future delimiters 0x06-0x0e reserved for future delimiters
0x0F reserved for future chunking-end-of-attributes-
Moore and Turner Expires May 7, 1998 tag
When an xxx-attributes-tag occurs in the protocol, it SHALL mean that When an xxx-attributes-tag occurs in the protocol, it SHALL mean that
the zero or more following attributes up to the next delimiter tag are zero or more following attributes up to the next delimiter tag are
xxx attributes as defined in the model document, where xxx is operation, attributes belonging to group xxx as defined in the model document,
job, printer, unsupported-job. where xxx is operation, job, printer, unsupported.
Moore and Turner Expires June 19, 1998
Doing substitution for xxx in the above paragraph, this means the Doing substitution for xxx in the above paragraph, this means the
following. When an operation-attributes-tag occurs in the protocol, it following. When an operation-attributes-tag occurs in the protocol, it
SHALL mean that the zero or more following attributes up to the next SHALL mean that the zero or more following attributes up to the next
delimiter tag are operation attributes as defined in the model document. delimiter tag are operation attributes as defined in the model document.
When an job-attributes-tag occurs in the protocol, it SHALL mean that When an job-attributes-tag occurs in the protocol, it SHALL mean that
the zero or more following attributes up to the next delimiter tag are the zero or more following attributes up to the next delimiter tag are
job attributes as defined in the model document. When an printer- job attributes as defined in the model document. When an printer-
attributes-tag occurs in the protocol, it SHALL mean that the zero or attributes-tag occurs in the protocol, it SHALL mean that the zero or
more following attributes up to the next delimiter tag are printer more following attributes up to the next delimiter tag are printer
attributes as defined in the model document. When an unsupported-job- attributes as defined in the model document. When an unsupported-
attributes-tag occurs in the protocol, it SHALL mean that the zero or attributes-tag occurs in the protocol, it SHALL mean that the zero or
more following attributes up to the next delimiter tag are unsupported- more following attributes up to the next delimiter tag are unsupported
job attributes as defined in the model document. attributes as defined in the model document.
The operation-attributes-tag and data-tag SHALL each occur exactly once The operation-attributes-tag and end-of-attributes-tag SHALL each occur
in an operation. The operation-attributes-tag SHALL be the first tag exactly once in an operation. The operation-attributes-tag SHALL be the
delimiter, and the data-tag SHALL be the last tag delimiter. first tag delimiter, and the end-of-attributes-tag SHALL be the last
tag delimiter. If the operation has a document-content group, the
document data in that group SHALL follow the end-of-attributes-tag
Each of the other three xxx-attributes-tags defined above is OPTIONAL Each of the other three xxx-attributes-tags defined above is OPTIONAL
in an operation and each SHALL occur at most once in an operation, in an operation and each SHALL occur at most once in an operation,
except for job-attributes-tag in a Get-Jobs response which may occur except for job-attributes-tag in a Get-Jobs response which may occur
zero or more times. zero or more times.
The order and presence of delimiter tags for each operation request and The order and presence of delimiter tags for each operation request and
each operation response SHALL be that defined in the model document. For each operation response SHALL be that defined in the model document. For
further details, see Section 3.8 Mapping of Attribute Names and further details, see Section 3.9 Mapping of Attribute Names and Error!
Appendix B: Mapping of Each Operation in the Encoding. Reference source not found..
3.6.2 Value Tags A Printer SHALL treat the reserved delimiter tags differently from
reserved value tags so that the Printer knows that there is an entire
attribute group that it doesn't understand as opposed to a single value
that it doesn't understand.
3.7.2 Value Tags
The remaining tables show values for the value-tag, which is the first The remaining tables show values for the value-tag, which is the first
octet of an attribute. The value-tag specifies the type of the value of octet of an attribute. The value-tag specifies the type of the value of
the attribute. If the value-tag specifies a type of compoundValue, it the attribute. The following table specifies the "out-of-band" values
represents a compound value whose type is the that of the last member of for the value-tag.
the compound value. The following table specifies the "out-of-band"
values for the value-tag.
Tag Value (Hex) Meaning Tag Value (Hex) Meaning
0x10 unsupported 0x10 unsupported
0x11 reserved for future `default' 0x11 reserved for future `default'
0x12 unknown 0x12 unknown
0x13 compoundValue 0x13 no-value
0x14-0x1F reserved for future "out-of-band" values. 0x14-0x1F reserved for future "out-of-band" values.
The "unsupported" value SHALL be used in the attribute-sequence of an The "unsupported" value SHALL be used in the attribute-sequence of an
error response for those attributes which the printer does not support. error response for those attributes which the printer does not support.
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
The "default" value is reserved for future use of setting value back to The "default" value is reserved for future use of setting value back to
their default value. The "unknown" value is used for the value of a their default value. The "unknown" value is used for the value of a
supported attribute when its value is temporarily unknown. . The supported attribute when its value is temporarily unknown. . The "no-
"compoundValue" SHALL be used to form a single value from a collection value" value is used for a supported attribute to which no value has
of values, and its value is the number of members forming the compound been assigned, e.g. "job-k-octets-supported" has no value if an
value, excluding the compoundValue. For example, a text value with a implementation supports this attribute, but an administrator has not
naturalLanguage override consists of 3 "values": a compoundValue with configured the printer to have a limit.
value 2, a naturalLanguage value and a text value.
The following table specifies the integer values for the value-tag The following table specifies the integer values for the value-tag
Tag Value (Hex) Meaning Tag Value (Hex) Meaning
0x20 reserved 0x20 reserved
0x21 integer 0x21 integer
0x22 boolean 0x22 boolean
0x23 enum 0x23 enum
0x24-0x2F reserved for future integer types 0x24-0x2F reserved for future integer types
skipping to change at page 10, line 37 skipping to change at page 11, line 36
The following table specifies the octetString values for the value-tag The following table specifies the octetString values for the value-tag
Tag Value (Hex) Meaning Tag Value (Hex) Meaning
0x30 octetString with an unspecified format 0x30 octetString with an unspecified format
0x31 dateTime 0x31 dateTime
0x32 resolution 0x32 resolution
0x33 rangeOfInteger 0x33 rangeOfInteger
0x34 reserved for dictionary (in the future) 0x34 reserved for dictionary (in the future)
0x35-0x3F reserved for future octetString types 0x35 textWithLanguage
0x36 nameWithLanguage
0x37-0x3F reserved for future octetString types
The following table specifies the character-string values for the value- The following table specifies the character-string values for the value-
tag tag
Tag Value (Hex) Meaning Tag Value (Hex) Meaning
0x40 reserved 0x40 reserved
0x41 text 0x41 text
0x42 name 0x42 name
0x43 reserved 0x43 reserved
0x44 keyword 0x44 keyword
0x45 uri 0x45 uri
0x46 uriScheme 0x46 uriScheme
0x47 charset 0x47 charset
0x48 naturalLanguage 0x48 naturalLanguage
0x49 mimeMediaType 0x49 mimeMediaType
0x4A-0x5F reserved for future character string types 0x4A-0x5F reserved for future character string types
Moore and Turner Expires June 19, 1998
NOTE: 0x40 is reserved for "generic character-string" if should ever be NOTE: 0x40 is reserved for "generic character-string" if should ever be
needed. needed.
Moore and Turner Expires May 7, 1998
The values 0x60-0xFF are reserved for future types. There are no values The values 0x60-0xFF are reserved for future types. There are no values
allocated for private extensions. A new type must be registered via the allocated for private extensions. A new type must be registered via the
type 2 process. type 2 process.
3.7 Name-Lengths 3.8 Name-Lengths
The name-length field SHALL consist of a SIGNED-SHORT. This field SHALL The name-length field SHALL consist of a SIGNED-SHORT. This field SHALL
specify the number of octets in the name field which follows the name- specify the number of octets in the name field which follows the name-
length field, excluding the two bytes of the name-length field. length field, excluding the two bytes of the name-length field.
If a name-length field has a value of zero, the following name field If a name-length field has a value of zero, the following name field
SHALL be empty, and the following value SHALL be treated as an SHALL be empty, and the following value SHALL be treated as an
additional value for the preceding attribute. Within an attribute- additional value for the preceding attribute. Within an attribute-
sequence, if two attributes have the same name, the first occurrence sequence, if two attributes have the same name, the first occurrence
SHALL be ignored. The zero-length name is the only mechanism for multi- SHALL be ignored. The zero-length name is the only mechanism for multi-
valued attributes. valued attributes.
3.8 Mapping of Attribute Names 3.9 Mapping of Attribute Names
Some attributes are encoded in a special position. These attribute are: Some attributes are encoded in a special position. These attribute are:
. "printer-uri": The target printer-uri of each operation in the IPP . "printer-uri": When the target is a printer and the transport is
model document SHALL be specified outside of the operation layer HTTP or HTTP (for TLS), the target printer-uri defined in each
as the request-URI on the Request-Line at the HTTP level. operation in the IPP model document SHALL be an operation attribute
. "job-uri": The target job-uri of each operation in the IPP model called "printer-uri" and it SHALL also be specified outside of the
document SHALL be specified outside of the operation layer as the operation layer as the request-URI on the Request-Line at the HTTP
level. This
. "job-uri": When the target is a job and the transport is HTTP or
HTTPS (for TLS), the target job-uri of each operation in the IPP
model document SHALL be an operation attribute called "job-uri" and
it SHALL also be specified outside of the operation layer as the
request-URI on the Request-Line at the HTTP level. request-URI on the Request-Line at the HTTP level.
. "document-content": The attribute named "document-content" in the
IPP model document SHALL become the "data" in the operation layer.
. "status-code": The attribute named "status-code" in the IPP model . "status-code": The attribute named "status-code" in the IPP model
document SHALL become the "status-code" field in the operation document SHALL become the "status-code" field in the operation
layer response. layer response. It SHALL NOT appear as an operation attribute.
The model document arranges the remaining attributes into groups for The model document arranges the remaining attributes into groups for
each operation request and response. Each such group SHALL be each operation request and response. Each such group SHALL be
represented in the protocol by an xxx-attribute-sequence preceded by the represented in the protocol by an xxx-attribute-sequence preceded by the
appropriate xxx-attributes-tag (See the table below and Appendix B: appropriate xxx-attributes-tag (See the table below and Error! Reference
Mapping of Each Operation in the Encoding). In addition, the order of source not found.). In addition, the order of these xxx-attributes-tags
these xxx-attributes-tags and xxx-attribute-sequences in the protocol and xxx-attribute-sequences in the protocol SHALL be the same as in the
SHALL be the same as in the model document, but the order of attributes model document, but the order of attributes within each xxx-attribute-
within each xxx-attribute-sequence SHALL be unspecified. The table below sequence SHALL be unspecified. The table below maps the model document
maps the model document group name to xxx-attributes-sequence group name to xxx-attributes-sequence
Model Document Group xxx-attributes-sequence Model Document Group xxx-attributes-sequence
Moore and Turner Expires June 19, 1998
Operation Attributes operations-attributes-sequence Operation Attributes operations-attributes-sequence
Job Template Attributes job-attributes-sequence Job Template Attributes job-attributes-sequence
Job Object Attributes job-attributes-sequence Job Object Attributes job-attributes-sequence
Unsupported Attributes unsupported-job-attributes-sequence Unsupported Attributes unsupported- attributes-sequence
Requested Attributes (Get- job-attributes-sequence Requested Attributes (Get- job-attributes-sequence
Attributes of job object) Job-Attributes)
Moore and Turner Expires May 7, 1998
Requested Attributes (Get- printer-attributes-sequence Requested Attributes (Get- printer-attributes-sequence
Attributes of printer object) Printer-Attributes)
Document Content in a special position as described above Document Content in a special position as described above
ISSUE: coordinate this with the model document.
If an operation contains attributes from more than one job object (e.g. If an operation contains attributes from more than one job object (e.g.
Get-Jobs response), the attributes from each job object SHALL be in a Get-Jobs response), the attributes from each job object SHALL be in a
separate job-attribute-sequence, such that the attributes from the ith separate job-attribute-sequence, such that the attributes from the ith
job object are in the ith job-attribute-sequence. See Section 11 job object are in the ith job-attribute-sequence. See Section Error!
"Appendix B: Mapping of Each Operation in the Encoding" for table Reference source not found. "Error! Reference source not found." for
showing the application of the rules above. table showing the application of the rules above.
3.9 Value Lengths 3.10 Value Lengths
Each attribute value SHALL be preceded by a SIGNED-SHORT which SHALL Each attribute value SHALL be preceded by a SIGNED-SHORT which SHALL
specify the number of octets in the value which follows this length, specify the number of octets in the value which follows this length,
exclusive of the two bytes specifying the length. exclusive of the two bytes specifying the length.
For any of the types represented by binary signed integers, the sender For any of the types represented by binary signed integers, the sender
MUST encode the value in exactly four octets.. MUST encode the value in exactly four octets..
For any of the types represented by character-strings, the sender MUST For any of the types represented by character-strings, the sender MUST
encode the value with all the characters of the string and without any encode the value with all the characters of the string and without any
padding characters. padding characters.
If a value-tag contains an "out-of-band" value which is not If a value-tag contains an "out-of-band" value, such as "unsupported",
compoundValue, such as "unsupported", the value-length SHALL be 0 and the value-length SHALL be 0 and the value empty " the value has no
the value empty " the value has no meaning when the value-tag has an meaning when the value-tag has an "out-of-band" value. If a client
"out-of-band" value. If a printer or client receives an operation with a receives a response with a nonzero value-length in this case, it SHALL
nonzero value-length in this case, it SHALL ignore the value field. ignore the value field. If a printer receives a request with a nonzero
value-length in this case, it SHALL reject the request.
3.10 Mapping of Attribute Values 3.11 Mapping of Attribute Values
The syntax types and most of the details of their representation are The syntax types and most of the details of their representation are
defined in the IPP model document. The table below augments the defined in the IPP model document. The table below augments the
information in the model document, and defines the syntax types from the information in the model document, and defines the syntax types from the
model document in terms of the 5 basic types defined in section 3 model document in terms of the 5 basic types defined in section 3
Encoding of the Operation Layer. The 5 types are US-ASCII-STRING, Encoding of the Operation Layer. The 5 types are US-ASCII-STRING,
LOCALIZED-STRING, SIGNED-INTEGER, SIGNED-SHORT, SIGNED-BYTE, and OCTET- LOCALIZED-STRING, SIGNED-INTEGER, SIGNED-SHORT, SIGNED-BYTE, and OCTET-
STRING. STRING.
Syntax of Encoding Syntax of Encoding
Attribute Value Attribute Value
text, name LOCALIZED-STRING. text, name LOCALIZED-STRING.
The override natural language mechanism is
encoded by syntactically preceding the text or
name value by two values: first a value of type
compoundValue whose value is 2 and second a value
of type naturalLanguage whose value is the
language override. From a protocol syntax view,
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
Syntax of Encoding Syntax of Encoding
Attribute Value Attribute Value
there are three separate values: the textWithLanguage OCTET"STRING consisting of 4 fields:
compoundValue, the naturalLanguage value and the a) a SIGNED-SHORT which is the number of octets
text or name value, but from a semantic view, the in the following field
Printer treats them as a single value where the b) a value of type natural-language,
naturalLanguage value overrides the language of c) a SIGNED-SHORT which is the number of octets
the immediately following text or name value in in the following field,
the attribute. The override applies to just the d) a value of type text.
text or name within the compound value. Other The length of a textWithLanguage value SHALL be
text or name values needing an override must be 4 + the value of field a + the value of field c.
overridden with additional compoundValues. nameWithLanguage OCTET"STRING consisting of 4 fields:
a) a SIGNED-SHORT which is the number of octets
in the following field
b) a value of type natural-language,
c) a SIGNED-SHORT which is the number of octets
in the following field
d) a value of type name.
The length of a nameWithLanguage value SHALL be
4 + the value of field a + the value of field c.
charset, US-ASCII-STRING charset, US-ASCII-STRING
naturalLanguage, naturalLanguage,
mimeMediaType, mimeMediaType,
keyword, uri, keyword, uri,
and uriScheme and uriScheme
boolean SIGNED-BYTE where 0x00 is `false' and 0x01 is boolean SIGNED-BYTE where 0x00 is `false' and 0x01 is
`true' `true'
integer and enum a SIGNED-INTEGER integer and enum a SIGNED-INTEGER
compoundValue a SIGNED-INTEGER with a special meaning.
If the value of a compoundValue is n, then the n
following values of the attribute form a single
value whose type is that of the last member of
the compound value. For example, if an attribute
has 3 successive values: compoundValue of 2,
naturalLanguage of `fr-CA' and name of `chien',
then these three "values" form a single value
which is a name of `chien' in Canadian French..
dateTime OCTET-STRING consisting of eleven octets whose dateTime OCTET-STRING consisting of eleven octets whose
contents are defined by "DateAndTime" in RFC 1903 contents are defined by "DateAndTime" in RFC 1903
[rfc1903]. Although RFC 1903 also defines an [rfc1903].
eight octet format which omits the time zone, a
value of this type in the IPP protocol MUST use
the eleven octet format. [ transfer to model].
resolution OCTET"STRING consisting of nine octets of 2 resolution OCTET"STRING consisting of nine octets of 2
SIGNED-INTEGERs followed by a SIGNED-BYTE. The SIGNED-INTEGERs followed by a SIGNED-BYTE. The
first SIGNED-INTEGER contains the value of cross first SIGNED-INTEGER contains the value of cross
feed direction resolution . The second SIGNED- feed direction resolution . The second SIGNED-
INTEGER contains the value of feed direction INTEGER contains the value of feed direction
resolution. The SIGNED-BYTE contains the unts resolution. The SIGNED-BYTE contains the units
value. value.
rangeOfInteger Eight octets consisting of 2 SIGNED-INTEGERs. The rangeOfInteger Eight octets consisting of 2 SIGNED-INTEGERs. The
first SIGNED-INTEGERs contains the lower bound first SIGNED-INTEGERs contains the lower bound
and the second SIGNED-INTEGERs contains the upper and the second SIGNED-INTEGERs contains the upper
bound bound
1setOf X encoding according to the rules for an attribute 1setOf X encoding according to the rules for an attribute
with more than 1 value. Each value X is encoded with more than 1 value. Each value X is encoded
according to the rules for encoding its type. according to the rules for encoding its type.
octetString OCTET-STRING octetString OCTET-STRING
Moore and Turner Expires May 7, 1998
The type of the value in the model document determines the encoding in The type of the value in the model document determines the encoding in
the value and the value of the value-tag. the value and the value of the value-tag.
3.11 Data Moore and Turner Expires June 19, 1998
3.12 Data
The data part SHALL include any data required by the operation The data part SHALL include any data required by the operation
4. Encoding of Transport Layer 4. Encoding of Transport Layer
HTTP/1.1 shall be the transport layer for this protocol. HTTP/1.1 shall be the transport layer for this protocol.
The operation layer has been designed with the assumption that the The operation layer has been designed with the assumption that the
transport layer contains the following information: transport layer contains the following information:
skipping to change at page 14, line 24 skipping to change at page 15, line 21
4. Encoding of Transport Layer 4. Encoding of Transport Layer
HTTP/1.1 shall be the transport layer for this protocol. HTTP/1.1 shall be the transport layer for this protocol.
The operation layer has been designed with the assumption that the The operation layer has been designed with the assumption that the
transport layer contains the following information: transport layer contains the following information:
. the URI of the target job or printer operation . the URI of the target job or printer operation
. the total length of the data in the operation layer, either as a . the total length of the data in the operation layer, either as a
single length or as a sequence of chunks each with a length. single length or as a sequence of chunks each with a length.
It is REQUIRED that a printer support HTTP over port 80, though a It is REQUIRED that a printer support HTTP over port 80, though a
printer may support HTTP over port 516 or some other port. In addition, printer may support HTTP over port some other port. In addition, a
a printer may have to support another port for secure connections. printer may have to support another port for privacy (See Section 5
"Security Considerations".
Note: Consistent with RFC 2068 (HTTP/1.1), HTTP URI's for IPP implicitly Note: Consistent with RFC 2068 (HTTP/1.1), HTTP URI's for IPP implicitly
reference port 80. If a URI references some other port, the port number reference port 80. If a URI references some other port, the port number
must be explicitly specified in the URI. must be explicitly specified in the URI.
Each HTTP operation shall use the POST method where the request-URI is Each HTTP operation shall use the POST method where the request-URI is
the object target of the operation, and where the "Content-Type" of the the object target of the operation, and where the "Content-Type" of the
message-body in each request and response shall be "application/ipp". message-body in each request and response shall be "application/ipp".
The message-body shall contain the operation layer and shall have the The message-body shall contain the operation layer and shall have the
syntax described in section 3.2 "Syntax of Encoding". A client syntax described in section 3.2 "Syntax of Encoding". A client
implementation SHALL adhere to the rules for a client described in RFC implementation SHALL adhere to the rules for a client described in RFC
2068 [rfc2068]. A printer (server) implementation SHALL adhere the rules 2068 [rfc2068]. A printer (server) implementation SHALL adhere the rules
for an origin server described in RFC 2068.In the following sections, for an origin server described in RFC 2068.
there are a tables of all HTTP headers which describe their use in an
IPP client or server. The following is an explanation of each column in The IPP layer doesn't have to deal with chunking. In the context of CGI
these tables. scripts, the HTTP layer removes any chunking information in the received
data.
A client SHALL NOT expect a response from an IPP server until after the
client has sent the entire response. But a client MAY listen for an
error response that an IPP server MAY send before it receives all the
data. In this case a client, if chunking the data, can send a premature
zero-length chunk to end the request before sending all the data. If the
request is blocked for some reason, a client MAY determine the reason by
opening another connection to query the server.
In the following sections, there are a tables of all HTTP headers which
describe their use in an IPP client or server. The following is an
explanation of each column in these tables.
. the "header" column contains the name of a header . the "header" column contains the name of a header
. the "request/client" column indicates whether a client sends the . the "request/client" column indicates whether a client sends the
header. header.
Moore and Turner Expires June 19, 1998
. the "request/ server" column indicates whether a server supports . the "request/ server" column indicates whether a server supports
the header when received. the header when received.
. the "response/ server" column indicates whether a server sends the . the "response/ server" column indicates whether a server sends the
header. header.
. the "response /client" column indicates whether a client supports . the "response /client" column indicates whether a client supports
the header when received. the header when received.
. the "values and conditions" column specifies the allowed header . the "values and conditions" column specifies the allowed header
values and the conditions for the header to be present in a values and the conditions for the header to be present in a
request/response. request/response.
The table for "request headers" does not have columns for responses, and The table for "request headers" does not have columns for responses, and
the table for "response headers" does not have columns for requests. the table for "response headers" does not have columns for requests.
Moore and Turner Expires May 7, 1998
The following is an explanation of the values in the "request/client" The following is an explanation of the values in the "request/client"
and "response/ server" columns. and "response/ server" columns.
. must: the client or server MUST send the header, . must: the client or server MUST send the header,
. must-if: the client or server MUST send the header when the . must-if: the client or server MUST send the header when the
condition described in the "values and conditions" column is met, condition described in the "values and conditions" column is met,
. may: the client or server MAY send the header . may: the client or server MAY send the header
. not: the client or server SHOULD NOT send the header. It is not . not: the client or server SHOULD NOT send the header. It is not
relevant to an IPP implementation. relevant to an IPP implementation.
skipping to change at page 15, line 29 skipping to change at page 16, line 41
. must: the client or server MUST support the header, . must: the client or server MUST support the header,
. may: the client or server MAY support the header . may: the client or server MAY support the header
. not: the client or server SHOULD NOT support the header. It is not . not: the client or server SHOULD NOT support the header. It is not
relevant to an IPP implementation. relevant to an IPP implementation.
4.1 General Headers 4.1 General Headers
The following is a table for the general headers. The following is a table for the general headers.
ISSUE: an HTTP expert should review these tables for accuracy.
General- Request Response Values and Conditions General- Request Response Values and Conditions
Header Header
Client Server Server Client Client Server Server Client
Cache- must not must not "no-cache" only Cache- must not must not "no-cache" only
Control Control
Connection must-if must must- must "close" only. Both Connection must-if must must- must "close" only. Both
if client and server if client and server
SHOULD keep a SHOULD keep a
connection for the connection for the
duration of a sequence duration of a sequence
of operations. The of operations. The
client and server MUST client and server MUST
include this header include this header
Moore and Turner Expires June 19, 1998
General- Request Response Values and Conditions
Header
Client Server Server Client
for the last operation for the last operation
in such a sequence. in such a sequence.
Date may may must may per RFC 1123 [rfc1123] Date may may must may per RFC 1123 [rfc1123]
from RFC 2068
Pragma` must not must not "no-cache" only Pragma` must not must not "no-cache" only
Transfer- must-if must must- must "chunked" only . Transfer- must-if must must- must "chunked" only .
Encoding if Header MUST be present Encoding if Header MUST be present
if Content-Length is if Content-Length is
absent. absent.
Upgrade not not not not Upgrade not not not not
Via not not not not Via not not not not
Moore and Turner Expires May 7, 1998
4.2 Request Headers 4.2 Request Headers
The following is a table for the request headers. The following is a table for the request headers.
Request-Header Client Server Request Values and Conditions Request-Header Client Server Request Values and Conditions
Accept may must "application/ipp" only. This Accept may must "application/ipp" only. This
value is the default if the value is the default if the
client omits it client omits it
Accept-Charset not not Charset information is within Accept-Charset not not Charset information is within
skipping to change at page 16, line 40 skipping to change at page 18, line 4
only with the user's approval, it only with the user's approval, it
is not very useful is not very useful
Host must must per RFC 2068 Host must must per RFC 2068
If-Match not not If-Match not not
If-Modified- not not If-Modified- not not
Since Since
If-None-Match not not If-None-Match not not
If-Range not not If-Range not not
If-Unmodified- not not If-Unmodified- not not
Since Since
Moore and Turner Expires June 19, 1998
Request-Header Client Server Request Values and Conditions
Max-Forwards not not Max-Forwards not not
Proxy- must-if not per RFC 2068. A client MUST send Proxy- must-if not per RFC 2068. A client MUST send
Authorization this header when it receives a Authorization this header when it receives a
401 "Unauthorized" response and a 401 "Unauthorized" response and a
"Proxy-Authenticate" header. "Proxy-Authenticate" header.
Range not not Range not not
Referer not not Referer not not
User-Agent not not User-Agent not not
4.3 Response Headers 4.3 Response Headers
The following is a table for the request headers. The following is a table for the request headers.
Response- Server Client Response Values and Conditions Response- Server Client Response Values and Conditions
Header Header
Accept-Ranges not not Accept-Ranges not not
Age not not Age not not
Location must-if may per RFC 2068. When URI needs Location must-if may per RFC 2068. When URI needs
Moore and Turner Expires May 7, 1998
Response- Server Client Response Values and Conditions
Header
redirection. redirection.
Proxy- not must per RFC 2068 Proxy- not must per RFC 2068
Authenticate Authenticate
Public may may per RFC 2068 Public may may per RFC 2068
Retry-After may may per RFC 2068 Retry-After may may per RFC 2068
Server not not Server not not
Vary not not Vary not not
Warning may may per RFC 2068 Warning may may per RFC 2068
WWW- must-if must per RFC 2068. When a server needs to WWW- must-if must per RFC 2068. When a server needs to
Authenticate authenticate a client. Authenticate authenticate a client.
skipping to change at page 17, line 39 skipping to change at page 19, line 4
Allow not not not not Allow not not not not
Content-Base not not not not Content-Base not not not not
Content- may must must must per RFC 2068 and IANA Content- may must must must per RFC 2068 and IANA
Encoding registry for content Encoding registry for content
codings. codings.
Content- not not not not Application/ipp Content- not not not not Application/ipp
Language handles language Language handles language
Content- must-if must must-if must the length of the Content- must-if must must-if must the length of the
Length message-body per RFC Length message-body per RFC
2068. Header MUST be 2068. Header MUST be
Moore and Turner Expires June 19, 1998
Entity-Header Request Response Values and Conditions
Client Server Server Client
present if Transfer- present if Transfer-
Encoding is absent.. Encoding is absent..
Content- not not not not Content- not not not not
Location Location
Content-MD5 may may may may per RFC 2068 Content-MD5 may may may may per RFC 2068
Content-Range not not not not Content-Range not not not not
Content-Type must must must must "application/ipp" Content-Type must must must must "application/ipp"
only only
ETag not not not not ETag not not not not
Expires not not not not Expires not not not not
Last-Modified not not not not Last-Modified not not not not
5. Security Considerations 5. Security Considerations
When utilizing HTTP 1.1 as a transport of IPP, the security The IPP Model document defines an IPP implementation with "privacy" as
considerations outlined in RFC 2068 [rfc2068] apply. Specifically, IPP one that implements Transport Layer Security (TLS) Version 1.0. TLS
servers can generate a 401 "Unauthorized" response code to request meets the requirements for IPP security with regards to features such as
client authentication and IPP clients should correctly respond with the mutual authentication and privacy (via encryption). The IPP Model
proper "Authorization" header. Both Basic Authentication (RFC 2068) and document also outlines IPP-specific security considerations and should
be the primary reference for security implications with regards to the
Moore and Turner Expires May 7, 1998 IPP protocol itself.
Digest Authentication (RFC 2069) [rfc2069] flavors of authentication
SHALL be supported. The server chooses which type(s) of authentication
to accept. Digest Authentication is a more secure method, and is always
preferred to Basic Authentication.
For secure communication (privacy in particular), IPP SHOULD be run The IPP Model document defines an IPP implementation with
using a secure communications channel. For this purpose it is the "authentication" as one that implements the standard way for
intention to define standardization of IPP in combination with Transport transporting IPP messages within HTTP 1.1. , These include the security
Layer Security (TLS), currently under development in the IETF, when the considerations outlined in the HTTP 1.1 standard document [rfc2068] and
TLS specifications are agreed and on the IETF standards track. Digest Authentication extension [rfc2069]..
As an intercept solution for secure communication, the Secure Socket The current HTTP infrastructure supports HTTP over TCP port 80. IPP
Layer 3.0 (SSL3) could be used, but be warned that such implementations servers MUST offer IPP services using HTTP over this port. IPP servers
may not be able to interoperate with a future standardized IPP and TLS are free to advertise services over other ports, in addition to this
solution. Appendix C gives some hints to implementors wanting to use port, but TCP port 80 MUST minimally be supported for IPP-over-HTTP
SSL3 as intercept solution. services.
It is possible to combine the techniques, HTTP 1.1 client authentication When IPP-over-HTTP-with-privacy implementations are deployed, these IPP
(either basic or digest) with a secure communications channel. Together implementations MUST use TCP port 443, and MUST advertise their IPP
the two are more secure than client authentication and they perform user service URI using an "HTTPS" URI scheme.
authentication.
See further discussion of IPP security concepts in the model document See further discussion of IPP security concepts in the model document
[ipp-mod].
6. Copyright 6. References
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it or
assist in its implementation may be prepared, copied, published and
distributed, in whole or in part, without restriction of any kind,
provided that the above copyright notice and this paragraph are included
on all such copies and derivative works. However, this document itself
may not be modified in any way, such as by removing the copyright notice
or references to the Internet Society or other Internet organizations,
except as needed for the purpose of developing Internet standards in
which case the procedures for copyrights defined in the Internet
Standards process must be followed, or as required to translate it into
languages other than English.
The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an "AS
IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
FORCE DISCLAIMS 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.
Moore and Turner Expires May 7, 1998
7. References
[rfc822] Crocker, D., "Standard for the Format of ARPA [rfc822] Crocker, D., "Standard for the Format of ARPA
Internet Text Messages", RFC 822, August 1982. Internet Text Messages", RFC 822, August 1982.
[rfc1123] Braden, S., "Requirements for Internet Hosts - [rfc1123] Braden, S., "Requirements for Internet Hosts -
Application and Support", RFC 1123, October, 1989, Application and Support", RFC 1123, October, 1989,
Moore and Turner Expires June 19, 1998
[rfc1179] McLaughlin, L. III, (editor), "Line Printer Daemon [rfc1179] McLaughlin, L. III, (editor), "Line Printer Daemon
Protocol" RFC 1179, August 1990. Protocol" RFC 1179, August 1990.
[rfc1630] T. Berners-Lee, "Universal Resource Identifiers in WWW: [rfc1630] T. Berners-Lee, "Universal Resource Identifiers in WWW:
A Unifying Syntax for the Expression of Names and Addresses of A Unifying Syntax for the Expression of Names and Addresses of
Objects on the Network as used in the Word-Wide Web", RFC 1630, Objects on the Network as used in the Word-Wide Web", RFC 1630,
June 1994. June 1994.
[rfc1759] Smith, R., Wright, F., Hastings, T., Zilles, S., and [rfc1759] Smith, R., Wright, F., Hastings, T., Zilles, S., and
Gyllenskog, J., "Printer MIB", RFC 1759, March 1995. Gyllenskog, J., "Printer MIB", RFC 1759, March 1995.
skipping to change at page 20, line 5 skipping to change at page 20, line 53
[rfc2069] J. Franks, et al, "An Extension to HTTP: Digest Access [rfc2069] J. Franks, et al, "An Extension to HTTP: Digest Access
Authentication" RFC 2069, January 1997 Authentication" RFC 2069, January 1997
[rfc2119] S. Bradner, "Key words for use in RFCs to Indicate [rfc2119] S. Bradner, "Key words for use in RFCs to Indicate
Requirement Levels", RFC 2119 , March 1997 Requirement Levels", RFC 2119 , March 1997
[rfc2184] N. Freed, K. Moore, "MIME Parameter Value and Encoded [rfc2184] N. Freed, K. Moore, "MIME Parameter Value and Encoded
Word Extensions: Character Sets, Languages, and Continuations", Word Extensions: Character Sets, Languages, and Continuations",
RFC 2184, August 1997, RFC 2184, August 1997,
Moore and Turner Expires May 7, 1998 [rfc2234] D. Crocker et al., "Augmented BNF for Syntax
Specifications: ABNF", RFC 2234. November 1997.
[abnf] D. Crocker et al., "Augmented BNF for Syntax Specifications:
ABNF", draft-ietf-drums-abnf-04.txt.
[char] N. Freed, J. Postel: IANA Charset Registration Procedures, Work [char] N. Freed, J. Postel: IANA Charset Registration Procedures, Work
in Progress (draft-freed-charset-reg-02.txt). in Progress (draft-freed-charset-reg-02.txt).
[dpa] ISO/IEC 10175 Document Printing Application (DPA), June 1996. [dpa] ISO/IEC 10175 Document Printing Application (DPA), June 1996.
Moore and Turner Expires June 19, 1998
[iana] IANA Registry of Coded Character Sets: ftp://ftp.isi.edu/in- [iana] IANA Registry of Coded Character Sets: ftp://ftp.isi.edu/in-
notes/iana/assignments/character-sets notes/iana/assignments/character-sets
[ipp-req] Wright, F. D., "Requirements for an Internet Printing [ipp-req] Wright, F. D., "Requirements for an Internet Printing
Protocol:" Protocol:"
[ipp-mod] Isaacson, S, deBry, R, Hastings, T, Herriot, R, Powell, [ipp-mod] Isaacson, S, deBry, R, Hastings, T, Herriot, R, Powell,
P, "Internet Printing Protocol/1.0: Model and Semantics" P, "Internet Printing Protocol/1.0: Model and Semantics"
[ssl] Netscape, The SSL Protocol, Version 3, (Text version 3.02) [ssl] Netscape, The SSL Protocol, Version 3, (Text version 3.02)
November 1996. November 1996.
8. Author's Address 7. Author's Address
Robert Herriot (editor) Paul Moore Robert Herriot (editor) Paul Moore
Sun Microsystems Inc. Microsoft Sun Microsystems Inc. Microsoft
901 San Antonio Road, MPK-17 One Microsoft Way 901 San Antonio Road, MPK-17 One Microsoft Way
Palo Alto, CA 94303 Redmond, WA 98053 Palo Alto, CA 94303 Redmond, WA 98053
Phone: 650-786-8995 Phone: 425-936-0908 Phone: 650-786-8995 Phone: 425-936-0908
Fax: 650-786-7077 Fax: 425-93MS-FAX Fax: 650-786-7077 Fax: 425-93MS-FAX
Email: robert.herriot@eng.sun.com Email: paulmo@microsoft.com Email: robert.herriot@eng.sun.com Email: paulmo@microsoft.com
skipping to change at page 20, line 51 skipping to change at page 21, line 43
Boise, ID 83714 Camas, WA 98607 Boise, ID 83714 Camas, WA 98607
Phone: 208-396-6000 Phone: 360-817-8456 Phone: 208-396-6000 Phone: 360-817-8456
Fax: 208-396-3457 Fax: : 360-817-8436 Fax: 208-396-3457 Fax: : 360-817-8436
Email: sbutler@boi.hp.com Email: rturner@sharplabs.com Email: sbutler@boi.hp.com Email: rturner@sharplabs.com
IPP Mailing List: ipp@pwg.org IPP Mailing List: ipp@pwg.org
IPP Mailing List Subscription: ipp-request@pwg.org IPP Mailing List Subscription: ipp-request@pwg.org
IPP Web Page: http://www.pwg.org/ipp/ IPP Web Page: http://www.pwg.org/ipp/
9. Other Participants: 8. Other Participants:
Chuck Adams - Tektronix Harry Lewis - IBM Chuck Adams - Tektronix Harry Lewis - IBM
Ron Bergman - Data Products Tony Liao - Vivid Image Ron Bergman - Data Products Tony Liao - Vivid Image
Keith Carter - IBM David Manchala - Xerox Keith Carter - IBM David Manchala - Xerox
Angelo Caruso - Xerox Carl-Uno Manros - Xerox Angelo Caruso - Xerox Carl-Uno Manros - Xerox
Moore and Turner Expires May 7, 1998
Jeff Copeland - QMS Jay Martin - Underscore Jeff Copeland - QMS Jay Martin - Underscore
Roger Debry - IBM Larry Masinter - Xerox Roger Debry - IBM Larry Masinter - Xerox
Lee Farrell - Canon Ira McDonald, Xerox Lee Farrell - Canon Ira McDonald, Xerox
Sue Gleeson - Digital Bob Pentecost - Hewlett-Packard Sue Gleeson - Digital Bob Pentecost - Hewlett-Packard
Charles Gordon - Osicom Patrick Powell - SDSU Charles Gordon - Osicom Patrick Powell - SDSU
Brian Grimshaw - Apple Jeff Rackowitz - Intermec Brian Grimshaw - Apple Jeff Rackowitz - Intermec
Jerry Hadsell - IBM Xavier Riley - Xerox Jerry Hadsell - IBM Xavier Riley - Xerox
Richard Hart - Digital Gary Roberts - Ricoh Richard Hart - Digital Gary Roberts - Ricoh
Moore and Turner Expires June 19, 1998
Tom Hastings - Xerox Stuart Rowley - Kyocera Tom Hastings - Xerox Stuart Rowley - Kyocera
Stephen Holmstead Richard Schneider - Epson Stephen Holmstead Richard Schneider - Epson
Zhi-Hong Huang - Zenographics Shigern Ueda - Canon Zhi-Hong Huang - Zenographics Shigern Ueda - Canon
Scott Isaacson - Novell Bob Von Andel - Allegro Software Scott Isaacson - Novell Bob Von Andel - Allegro Software
Rich Lomicka - Digital William Wagner - Digital Products Rich Lomicka - Digital William Wagner - Digital Products
David Kellerman - Northlake Jasper Wong - Xionics David Kellerman - Northlake Jasper Wong - Xionics
Software Software
Robert Kline - TrueSpectra Don Wright - Lexmark Robert Kline - TrueSpectra Don Wright - Lexmark
Dave Kuntz - Hewlett-Packard Rick Yardumian - Xerox Dave Kuntz - Hewlett-Packard Rick Yardumian - Xerox
Takami Kurono - Brother Lloyd Young - Lexmark Takami Kurono - Brother Lloyd Young - Lexmark
Rich Landau - Digital Peter Zehler - Xerox Rich Landau - Digital Peter Zehler - Xerox
Greg LeClair - Epson Frank Zhao - Panasonic Greg LeClair - Epson Frank Zhao - Panasonic
Steve Zilles - Adobe Steve Zilles - Adobe
10. Appendix A: Protocol Examples 9. Appendix A: Protocol Examples
10.1 Print-Job Request 9.1 Print-Job Request
The following is an example of a Print-Job request with job-name, The following is an example of a Print-Job request with job-name,
copies, and sides specified. copies, and sides specified.
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x0100 1.0 version 0x0100 1.0 version
0x0002 PrintJob operation 0x0002 PrintJob operation
0x01 start operation- operation-attributestag 0x01 start operation- operation-attributestag
attributes attributes
skipping to change at page 22, line 4 skipping to change at page 22, line 51
0x001B name-length 0x001B name-length
attributes-natural- attributes-natural- name attributes-natural- attributes-natural- name
language language language language
0x0005 value-length 0x0005 value-length
en-US en-US value en-US en-US value
0x42 name type value-tag 0x42 name type value-tag
0x0008 name-length 0x0008 name-length
job-name job-name name job-name job-name name
0x0006 value-length 0x0006 value-length
foobar foobar value foobar foobar value
Moore and Turner Expires May 7, 1998
Octets Symbolic Value Protocol field
0x02 start job- job-attributes-tag 0x02 start job- job-attributes-tag
attributes attributes
0x21 integer type value-tag 0x21 integer type value-tag
0x0005 name-length 0x0005 name-length
copies copies name copies copies name
0x0004 value-length 0x0004 value-length
0x00000014 20 value 0x00000014 20 value
0x44 keyword type value-tag 0x44 keyword type value-tag
Moore and Turner Expires June 19, 1998
Octets Symbolic Value Protocol field
0x0005 name-length 0x0005 name-length
sides sides name sides sides name
0x0013 value-length 0x0013 value-length
two-sided-long-edge two-sided-long-edge value two-sided-long-edge two-sided-long-edge value
0x03 start-data data-tag 0x03 end-of-attributes end-of-attributes-tag
%!PS... <PostScript> data %!PS... <PostScript> data
10.2 Print-Job Response (successful) 9.2 Print-Job Response (successful)
Here is an example of a Print-Job response which is successful: Here is an example of a Print-Job response which is successful:
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x0100 1.0 version 0x0100 1.0 version
0x0000 OK (successful) status-code 0x0000 OK (successful) status-code
0x01 start operation- operation-attributes-tag 0x01 start operation- operation-attributes-tag
attributes attributes
0x47 charset type value-tag 0x47 charset type value-tag
skipping to change at page 23, line 4 skipping to change at page 23, line 51
0x000E name-length 0x000E name-length
status-message status-message name status-message status-message name
0x0002 value-length 0x0002 value-length
OK OK value OK OK value
0x02 start job- job-attributes-tag 0x02 start job- job-attributes-tag
attributes attributes
0x21 integer value-tag 0x21 integer value-tag
0x0007 name-length 0x0007 name-length
job-id job-id name job-id job-id name
0x0004 value-length 0x0004 value-length
Moore and Turner Expires May 7, 1998
Octets Symbolic Value Protocol field
147 147 value 147 147 value
0x45 uri type value-tag 0x45 uri type value-tag
0x0008 name-length 0x0008 name-length
job-uri job-uri name job-uri job-uri name
0x000E value-length 0x000E value-length
http://foo/123 http://foo/123 value http://foo/123 http://foo/123 value
0x25 name type value-tag 0x25 name type value-tag
0x0008 name-length 0x0008 name-length
Moore and Turner Expires June 19, 1998
Octets Symbolic Value Protocol field
job-state job-state name job-state job-state name
0x0001 value-length 0x0001 value-length
0x03 pending value 0x03 pending value
0x03 start-data data-tag 0x03 end-of- end-of-attributes-tag
attributes
10.3 Print-Job Response (failure) 9.3 Print-Job Response (failure)
Here is an example of a Print-Job response which fails because the Here is an example of a Print-Job response which fails because the
printer does not support sides and because the value 20 for copies is printer does not support sides and because the value 20 for copies is
not supported: not supported:
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x0100 1.0 version 0x0100 1.0 version
0x0400 client-error-bad-request status-code 0x0400 client-error-bad-request status-code
0x01 start operation- operation-attribute tag 0x01 start operation- operation-attribute tag
attributes attributes
0x47 charset type value-tag 0x47 charset type value-tag
0x0012 name-length 0x0012 name-length
attributes- attributes-charset name attributes- attributes-charset name
charset charset
0x0008 value-length 0x0008 value-length
US-ASCII US-ASCII value US-ASCII US-ASCII value
0x48 natural-language type value-tag 0x48 natural-language type value-tag
0x001B name-length 0x001B name-length
attributes- attributes-natural- name attributes- name
natural- language natural- language attributes-natural-
language language
0x0005 value-length 0x0005 value-length
en-US en-US value en-US en-US value
0x41 text type value-tag 0x41 text type value-tag
0x000E name-length 0x000E name-length
status-message status-message name status-message status-message name
0x000D value-length 0x000D value-length
bad-request bad-request value bad-request bad-request value
0x04 start unsupported-job- unsupported-job- 0x04 start unsupported- unsupported- attributes-
attributes attributes-tag attributes tag
0x21 integer type value-tag
0x000C name-length
job-k-octets job-k-octets name
0x0004 value-length
0x001000000 16777216 value
0x21 integer type value-tag 0x21 integer type value-tag
0x0005 name-length 0x0005 name-length
copies copies name copies copies name
0x0004 value-length 0x0004 value-length
0x00000014 20 value 0x00000014 20 value
0x10 unsupported (type) value-tag
0x0005 name-length
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x10 unsupported (type) value-tag
0x0005 name-length
sides sides name sides sides name
0x0000 value-length 0x0000 value-length
0x03 start-data data-tag 0x03 end-of-attributes end-of-attributes-tag
10.4 Print-URI Request 9.4 Print-URI Request
The following is an example of Print-URI request with copies and job- The following is an example of Print-URI request with copies and job-
name parameters. name parameters.
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x0100 1.0 version 0x0100 1.0 version
0x0003 Print-URI operation 0x0003 Print-URI operation
0x01 start operation- operation-attributes-tag 0x01 start operation- operation-attributes-tag
attributes attributes
0x47 charset type value-tag 0x47 charset type value-tag
skipping to change at page 24, line 54 skipping to change at page 25, line 52
job-name job-name name job-name job-name name
0x0006 value-length 0x0006 value-length
foobar foobar value foobar foobar value
0x02 start job- job-attributes-tag 0x02 start job- job-attributes-tag
attributes attributes
0x21 integer type value-tag 0x21 integer type value-tag
0x0005 name-length 0x0005 name-length
copies copies name copies copies name
0x0004 value-length 0x0004 value-length
0x00000001 1 value 0x00000001 1 value
0x03 start-data data-tag 0x03 end-of-attributes end-of-attributes-tag
%!PS... <PostScript> data %!PS... <PostScript> data
Moore and Turner Expires May 7, 1998 9.5 Create-Job Request
10.5 Create-Job Request
The following is an example of Create-Job request with no parameters and The following is an example of Create-Job request with no parameters and
no attributes no attributes
Moore and Turner Expires June 19, 1998
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x0100 1.0 version 0x0100 1.0 version
0x0005 Create-Job operation 0x0005 Create-Job operation
0x01 start operation-attributes-tag 0x01 start operation-attributes-tag
operation- operation-
attributes attributes
0x47 charset type value-tag 0x47 charset type value-tag
0x0012 name-length 0x0012 name-length
attributes- attributes- name attributes- attributes- name
charset charset charset charset
0x0008 value-length 0x0008 value-length
US-ASCII US-ASCII value US-ASCII US-ASCII value
0x48 natural- value-tag 0x48 natural- value-tag
language type language type
0x001B name-length 0x001B name-length
attributes- attributes- name attributes- attributes- name
natural- natural- natural- natural-
language language language language
0x0005 value-length 0x0005 value-length
en-US en-US value en-US en-US value
0x03 start-data data-tag 0x03 end-of- end-of-attributes-tag
attributes
10.6 Get-Jobs Request 9.6 Get-Jobs Request
The following is an example of Get-Jobs request with parameters but no The following is an example of Get-Jobs request with parameters but no
attributes. attributes.
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x0100 1.0 version 0x0100 1.0 version
0x000A Get-Jobs operation 0x000A Get-Jobs operation
0x01 start operation- operation-attributes- 0x01 start operation- operation-attributes-
attributes tag attributes tag
0x47 charset type value-tag 0x47 charset type value-tag
skipping to change at page 26, line 4 skipping to change at page 26, line 57
0x001B name-length 0x001B name-length
attributes-natural- attributes-natural- name attributes-natural- attributes-natural- name
language language language language
0x0005 value-length 0x0005 value-length
en-US en-US value en-US en-US value
0x21 integer type value-tag 0x21 integer type value-tag
0x0005 name-length 0x0005 name-length
limit limit name limit limit name
0x0004 value-length 0x0004 value-length
0x00000032 50 value 0x00000032 50 value
Moore and Turner Expires May 7, 1998
Octets Symbolic Value Protocol field
0x44 keyword type value-tag 0x44 keyword type value-tag
0x0014 name-length 0x0014 name-length
requested-attributes requested-attributes name requested-attributes requested-attributes name
0x0006 value-length 0x0006 value-length
Moore and Turner Expires June 19, 1998
Octets Symbolic Value Protocol field
job-id job-id value job-id job-id value
0x44 keyword type value-tag 0x44 keyword type value-tag
0x0000 additional value name-length 0x0000 additional value name-length
0x0008 value-length 0x0008 value-length
job-name job-name value job-name job-name value
0x03 start-data data-tag 0x44 keyword type value-tag
0x0000 additional value name-length
0x000F value-length
document-format document-format value
0x03 end-of-attributes end-of-attributes-tag
10.7 Get-Jobs Response 9.7 Get-Jobs Response
The following is an of Get-Jobs response from previous request with 3 The following is an of Get-Jobs response from previous request with 3
jobs. The Printer returns no information about the second job. jobs. The Printer returns no information about the second job.
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x0100 1.0 version 0x0100 1.0 version
0x0000 OK (successful) status-code 0x0000 OK (successful) status-code
0x01 start operation- operation-attribute-tag 0x01 start operation- operation-attribute-tag
attributes attributes
0x47 charset type value-tag 0x47 charset type value-tag
skipping to change at page 27, line 5 skipping to change at page 28, line 5
attributes- attributes-natural- name attributes- attributes-natural- name
natural-language language natural-language language
0x0005 value-length 0x0005 value-length
fr-CA fr-CA value fr-CA fr-CA value
0x21 integer type value-tag 0x21 integer type value-tag
0x0006 name-length 0x0006 name-length
job-id job-id name job-id job-id name
0x0004 value-length 0x0004 value-length
147 147 value 147 147 value
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
Octets Symbolic Value Protocol field Octets Symbolic Value Protocol field
0x42 name type value-tag 0x42 name type value-tag
0x0008 name-length 0x0008 name-length
job-name job-name name job-name job-name name
0x0003 name-length 0x0003 name-length
fou fou name fou fou name
0x02 start job-attributes job-attributes-tag 0x02 start job-attributes job-attributes-tag
(2nd object) (2nd object)
0x02 start job-attributes job-attributes-tag 0x02 start job-attributes job-attributes-tag
(3rd object) (3rd object)
0x21 integer type value-tag 0x21 integer type value-tag
0x0006 name-length 0x0006 name-length
job-id job-id name job-id job-id name
0x0004 value-length 0x0004 value-length
148 148 value 148 148 value
0x13 compoundValue value-tag 0x35 nameWithLanguage value-tag
0x0008 name-length 0x0008 name-length
job-name job-name name job-name job-name name
0x0004 value-length 0x0012 value-length
0x0002 2 value (number of values) 0x0005 sub-value-length
0x48 naturalLanguage value-tag
0x0000 multi-value marker name-length
0x0005 value-length
de-CH de-CH value de-CH de-CH value
0x42 name type value-tag 0x0009 sub-value-length
0x0000 multi-value marker name-length
0x0003 name-length
isch guet isch guet name isch guet isch guet name
0x03 start-data data-tag 0x03 end-of-attributes end-of-attributes-tag
11. Appendix B: Mapping of Each Operation in the Encoding
The next three tables show the results of applying the rules above to
the operations defined in the IPP model document. There is no
information in these tables that cannot be derived from the rules
presented in Section 3.8 "Mapping of Attribute Names".
The following table shows the mapping of all IPP model-document request
attributes to an appropriate xxx-attribute-sequence or special position
in the protocol.
The table below shows the attributes for operations sent to a Printer
URI.
Operation operation job attributes special position
attributes
Print-Job attributes- job-template document-content 10. Appendix B: Hints to implementors using IPP with SSL3
charset attributes
attributes-
natural-
language
job-name
Moore and Turner Expires May 7, 1998 WARNING: Clients and IPP objects using intermediate secure connection
protocol solutions such as IPP in combination with Secure Socket Layer
Version 3 (SSL3), which are developed in advance of IPP and TLS
standardization, might not be interoperable with IPP and TLS standards-
conforming clients and IPP objects.
Operation operation job attributes special position An assumption is that the URI for a secure IPP Printer object has been
attributes found by means outside the IPP printing protocol, via a directory
service, web site or other means.
document-name IPP provides a transparent connection to SSL by calling the
ipp-attribute- corresponding URL (a https URI connects by default to port 443).
fidelity However, the following functions can be provided to ease the integration
of IPP with SSL during implementation.
document- connect (URI), returns a status.
natural-
language
Create-Job or attributes- job-template
Validate-Job charset attributes
attributes-
natural-
language job-
name
ipp-attribute-
fidelity
Print-URI attributes- job-template
charset attributes
attributes-
natural-
language job-
name
ipp-attribute-
fidelity
document-uri
document- "connect" makes an https call and returns the immediate status of
natural- the connection as returned by SSL to the user. The status values are
language explained in section 5.4.2 of the SSL document [ssl].
Send-Document attributes- document-content
charset
attributes-
natural-
language job-id
last-document
document-name
document- A session-id may also be retained to later resume a session. The SSL
natural- handshake protocol may also require the cipher specifications
language supported by the client, key length of the ciphers, compression
Send-URI attributes- methods, certificates, etc. These should be sent to the server and
charset hence should be available to the IPP client (although as part of
attributes- administration features).
natural-
language job-id
last-document
document-name
document-uri
document- Moore and Turner Expires June 19, 1998
natural-
Moore and Turner Expires May 7, 1998 disconnect (session)
Operation operation job attributes special position to disconnect a particular session.
attributes
language The session-id available from the "connect" could be used.
Cancel-Job attributes-
charset
attributes-
natural-
language job-id
message
Get-Attributes attributes-
(for a Printer) charset
attributes-
natural-
language
requested-
attributes
document-format
Get-Attributes attributes-
(for a Job) charset
attributes-
natural-
language job-id
requested-
attributes
Get-Jobs attributes-
charset
attributes-
natural-
language limit
requested-
attributes
which-jobs
The table below shows the attributes for operations sent to a Job URI. resume (session)
Operation operation job attributes special position to reconnect using a previous session-id.
attributes
Send-Document attributes- document-content The availability of this information as administration features are left
charset for implementors, and need not be standardized at this time
attributes-
natural-
language last-
document
document-name
document- 11. Appendix C: Registration of MIME Media Type Information for
natural- "application/ipp"
language
Send-URI attributes-
charset
Moore and Turner Expires May 7, 1998 This appendix contains the information that IANA requires for
registering a MIME media type. The information following this paragraph
will be forwarded to IANA to register application/ipp whose contents are
defined in Section 3 "Encoding of the Operation Layer" in this
document.
Operation operation job attributes special position MIME type name: application
attributes
attributes- MIME subtype name: ipp
natural-
language last-
document
document-name
document-uri
document- A Content-Type of "application/ipp" indicates an Internet Printing
natural- Protocol message body (request or response). Currently there is one
language version: IPP/1.0, whose syntax is described in Section 3 "Encoding of
Cancel-Job attributes- the Operation Layer" of [IPP-PRO], and whose semantics are described in
charset [IPP-MOD]
attributes-
natural-
language
message
Get-Attributes attributes-
(for a Job) charset
attributes-
natural-
language
requested-
attributes
The following two tables shows the mapping of all IPP model-document Required parameters: none
response attributes to an appropriate xxx-attribute-sequence or special
position in the protocol.
Operation operation job- unsupported-job- special Optional parameters: none
attributes attributes attributes position
Print-Job, attributes- job-id unsupported status- Encoding considerations:
Print-URI, charset job-uri attributes code
Create-Job, attributes- job-state
Send-Document natural- job-state-
or Send-URI language reasons
status- job-state-
message message
number-of-
intervening
-jobs
Validate-Job attributes- unsupported status- IPP/1.0 protocol requests/responses MAY contain long lines and ALWAYS
charset attributes code contain binary data (for example attribute value lengths).
attributes-
natural-
language
status-
Moore and Turner Expires May 7, 1998 Security considerations:
Operation operation job- unsupported-job- special IPP/1.0 protocol requests/responses do not introduce any security risks
attributes attributes attributes position not already inherent in the underlying transport protocols. Protocol
mixed-version interworking rules in [IPP-MOD] as well as protocol
encoding rules in [IPP-PRO] are complete and unambiguous.
message Interoperability considerations:
Note: the unsupported-job-attributes are present only if the client IPP/1.0 requests (generated by clients) and responses (generated by
included some job attributes that the Printer doesn't support. servers) MUST comply with all conformance requirements imposed by the
normative specifications [IPP-MOD] and [IPP-PRO]. Protocol encoding
Note: the job-attributes are present only if the server returns the Moore and Turner Expires June 19, 1998
status code of successful-ok or successful-ok-ignored-or-substituted-
attributes.
Operation operation job- printer- special rules specified in [IPP-PRO] are comprehensive, so that interoperability
attributes attributes attributes position between conforming implementations is guaranteed (although support for
specific optional features is not ensured). Both the "charset" and
"natural-language" of all IPP/1.0 attribute values of syntax "text" or
"name" are explicit within IPP protocol requests/responses (without
recourse to any external information in HTTP, SMTP, or other message
transport headers).
Cancel-Job attributes- Published specification:
charset
attributes-
natural-
language
status- status-code
message
Get-Attributes attributes- requested status-code [IPP-MOD] R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell,
(of a job) charset attributes "Internet Printing Protocol/1.0: Model and Semantics", work in progress
attributes- <draft-ietf-ipp-model-08.txt>, December 1997.
natural-
language
status-
message
Get-Attributes attributes- requested status-code [IPP-PRO] R. Herriot , S. Butler, P. Moore, R. Turner, "Internet
(of a printer) charset attributes Printing Protocol/1.0: Protocol Specification", work in progress <draft-
attributes- ietf-ipp-protocol-04.txt>, December 1997.
natural-
language
status-
message
Get-Jobs attributes- requested status-code Applications which use this media type:
charset attributes
attributes- (see the
natural- Note below)
language
status-
message
Note for Get-Jobs: there is a separate job-attribute-sequence containing Internet Printing Protocol (IPP) print clients and print servers,
requested-attributes for each job object in the response communicating using HTTP/1.1 (see [IPP-PRO]), SMTP/ESMTP, FTP, or other
transport protocol. Messages of type "application/ipp" are self-
contained and transport-independent, including "charset" and "natural-
language" context for any "text" or "name" attributes.
Moore and Turner Expires May 7, 1998 Person & email address to contact for further information:
12. Appendix C: Hints to implementors using IPP with SSL3 Scott A. Isaacson
Novell, Inc.
122 E 1700 S
Provo, UT 84606
WARNING: Clients and IPP objects using intermediate secure connection Phone: 801-861-7366
protocol solutions such as IPP in combination with Secure Socket Layer Fax: 801-861-4025
Version 3 (SSL3), which are developed in advance of IPP and TLS Email: sisaacson@novell.com
standardization, might not be interoperable with IPP and TLS standards-
conforming clients and IPP objects.
An assumption is that the URI for a secure IPP Printer object has been or
found by means outside the IPP printing protocol, via a directory
service, web site or other means.
IPP provides a transparent connection to SSL by calling the Robert Herriot
corresponding URL (a https URI connects by default to port 443). Sun Microsystems Inc.
However, the following functions can be provided to ease the integration 901 San Antonio Road, MPK-17
of IPP with SSL during implementation. Palo Alto, CA 94303
connect (URI), returns a status. Phone: 650-786-8995
Fax: 650-786-7077
Email: robert.herriot@eng.sun.com
"connect" makes an https call and returns the immediate status of Intended usage:
the connection as returned by SSL to the user. The status values are
explained in section 5.4.2 of the SSL document [ssl].
A session-id may also be retained to later resume a session. The SSL COMMON
handshake protocol may also require the cipher specifications
supported by the client, key length of the ciphers, compression
methods, certificates, etc. These should be sent to the server and
hence should be available to the IPP client (although as part of
administration features).
disconnect (session) Moore and Turner Expires June 19, 1998
to disconnect a particular session. 12. Appendix D: Full Copyright Statement
The session-id available from the "connect" could be used. Copyright (C)The Internet Society (1997). All Rights Reserved
resume (session) This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it or
assist in its implementation may be prepared, copied, published and
distributed, in whole or in part, without restriction of any kind,
provided that the above copyright notice and this paragraph are included
on all such copies and derivative works. However, this document itself
may not be modified in any way, such as by removing the copyright notice
or references to the Internet Society or other Internet organizations,
except as needed for the purpose of developing Internet standards in
which case the procedures for copyrights defined in the Internet
Standards process must be followed, or as required to translate it into
languages other than English.
to reconnect using a previous session-id. The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
The availability of this information as administration features are left This document and the information contained herein is provided on an "AS
for implementors, and need not be standardized at this time IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
FORCE DISCLAIMS 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.
Moore and Turner Expires May 7, 1998 Moore and Turner Expires June 19, 1998
 End of changes. 

This html diff was produced by rfcdiff 1.25, available from http://www.levkowetz.com/ietf/tools/rfcdiff/