idnits 2.17.1 draft-ietf-ipp-indp-method-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Missing expiration date. The document expiration date should appear on the first and last page. ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document is more than 15 pages and seems to lack a Table of Contents. == No 'Intended status' indicated for this document; assuming Proposed Standard == The page length should not exceed 58 lines per page, but there was 19 longer pages, the longest (page 9) being 65 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. ** The abstract seems to contain references ([RFC2568], [RFC2616], [RFC2569], [RFC2567]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. RFC 2119 keyword, line 37: '...pecification [ipp-ntfy] is an OPTIONAL...' RFC 2119 keyword, line 68: '... IPP/1.0. A few OPTIONAL operator ope...' RFC 2119 keyword, line 203: '...d terms, such as MUST, MUST NOT, REQUI...' RFC 2119 keyword, line 204: '...Y, NEED NOT, and OPTIONAL, have specia...' RFC 2119 keyword, line 266: '...MUST indicate whether the OPTIONAL...' (63 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 278 has weird spacing: '... or not yes, ...' == Line 320 has weird spacing: '...whether the D...' == Line 324 has weird spacing: '...one per sam...' == Line 901 has weird spacing: '...for the purpo...' -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (July 6, 2000) is 8685 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Missing reference section? 'RFC2567' on line 52 looks like a reference -- Missing reference section? 'RFC2568' on line 54 looks like a reference -- Missing reference section? 'RFC2569' on line 58 looks like a reference -- Missing reference section? 'RFC2616' on line 79 looks like a reference -- Missing reference section? 'RFC2119' on line 206 looks like a reference -- Missing reference section? 'IPP-MOD' on line 460 looks like a reference Summary: 8 errors (**), 0 flaws (~~), 7 warnings (==), 8 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 INTERNET-DRAFT There are 4 issues 3 4 Hugo Parra 5 Novell, Inc. 6 Tom Hastings 7 Xerox Corp. 8 July 6, 2000 10 Internet Printing Protocol (IPP): 12 The 'indp' Notification Delivery Method 14 Copyright (C) The Internet Society (2000). All Rights Reserved. 16 Status of this Memo 18 This document is an Internet-Draft and is in full conformance with all 19 provisions of Section 10 of [rfc2026]. Internet-Drafts are working 20 documents of the Internet Engineering Task Force (IETF), its areas, and 21 its working groups. Note that other groups may also distribute working 22 documents as Internet-Drafts. 24 Internet-Drafts are draft documents valid for a maximum of six months 25 and may be updated, replaced, or obsoleted by other documents at any 26 time. It is inappropriate to use Internet-Drafts as reference material 27 or to cite them other than as "work in progress". 29 The list of current Internet-Drafts can be accessed at 30 http://www.ietf.org/ietf/1id-abstracts.txt 32 The list of Internet-Draft Shadow Directories can be accessed as 33 http://www.ietf.org/shadow.html. 35 Abstract 37 The IPP Event Notification specification [ipp-ntfy] is an OPTIONAL 38 extension to IPP/1.0, IPP/1.1, and future versions. [ipp-ntfy] requires 39 the definition of one or more Delivery Methods in separate Delivery 40 Method Documents for the Printer to dispatch Event Notifications to 41 Notification Recipients. This Delivery Method Document defines the 42 semantics and syntax of the 'indp' Notification Delivery Method. For 43 this Delivery Method, an IPP Printer sends (pushes) an IPP Event 44 Notifications request to the Notification Recipients using the Send- 45 Notifications operation defined in this document. The Notification 46 Recipient returns a response to the Printer. The Send-Notifications 47 operation uses the same Encoding and Transport as IPP itself. 49 Expires: January 6, 2001 50 The full set of IPP documents includes: 52 Design Goals for an Internet Printing Protocol [RFC2567] 53 Rationale for the Structure and Model and Protocol for the Internet 54 Printing Protocol [RFC2568] 55 Internet Printing Protocol/1.1: Model and Semantics [ipp-mod] 56 Internet Printing Protocol/1.1: Encoding and Transport [ipp-pro] 57 Internet Printing Protocol/1.1: Implementer's Guide [ipp-iig] 58 Mapping between LPD and IPP Protocols [RFC2569] 59 Internet Printing Protocol (IPP): IPP Event Notification 60 Specification [ipp-ntfy] 62 The "Design Goals for an Internet Printing Protocol" document takes a 63 broad look at distributed printing functionality, and it enumerates 64 real-life scenarios that help to clarify the features that need to be 65 included in a printing protocol for the Internet. It identifies 66 requirements for three types of users: end users, operators, and 67 administrators. It calls out a subset of end user requirements that are 68 satisfied in IPP/1.0. A few OPTIONAL operator operations have been 69 added to IPP/1.1. 71 The "Rationale for the Structure and Model and Protocol for the Internet 72 Printing Protocol" document describes IPP from a high level view, 73 defines a roadmap for the various documents that form the suite of IPP 74 specification documents, and gives background and rationale for the IETF 75 working group's major decisions. 77 The "Internet Printing Protocol/1.1: Encoding and Transport" document is 78 a formal mapping of the abstract operations and attributes defined in 79 the model document onto HTTP/1.1 [RFC2616]. It defines the encoding 80 rules for a new Internet MIME media type called "application/ipp". This 81 document also defines the rules for transporting a message body over 82 HTTP whose Content-Type is "application/ipp". This document defines a 83 new scheme named 'ipp' for identifying IPP printers and jobs. 85 The "Internet Printing Protocol/1.1: Implementer's Guide" document gives 86 insight and advice to implementers of IPP clients and IPP objects. It 87 is intended to help them understand IPP/1.1 and some of the 88 considerations that may assist them in the design of their client and/or 89 IPP object implementations. For example, a typical order of processing 90 requests is given, including error checking. Motivation for some of the 91 specification decisions is also included. 93 The "Mapping between LPD and IPP Protocols" document gives some advice 94 to implementers of gateways between IPP and LPD (Line Printer Daemon) 95 implementations. 97 The "Internet Printing Protocol (IPP): IPP Event Notification 98 Specification" document defines the semantics for Subscription Creation 99 Operations and the requirements for other Delivery Method documents to 100 define a Delivery Method to carry an Event Notifications to a 101 Notification Recipient. 103 Expires: January 6, 2001 104 Table of Contents 106 1 Introduction......................................................5 108 2 Terminology.......................................................5 110 3 Model and Operation...............................................5 112 4 Summary of the 'indp' Delivery Method.............................6 114 5 Subscription object attributes....................................8 115 5.1SUBSCRIPTION TEMPLATE ATTRIBUTE CONFORMANCE......................8 116 5.2SUBSCRIPTION DESCRIPTION ATTRIBUTE CONFORMANCE...................8 118 6 Printer Description Attribute Conformance.........................9 120 7 New Values for Existing Printer Description Attributes............9 121 7.1NOTIFY-SCHEMES-SUPPORTED (1SETOF URISCHEME)......................9 122 7.2OPERATIONS-SUPPORTED (1SETOF TYPE2 ENUM).........................9 123 0X001D..............................................................9 125 8 Attributes Only in Event Notifications............................9 127 9 Operations for Notification.......................................9 128 9.1SEND-NOTIFICATIONS OPERATION....................................10 129 9.1.1 Send-Notifications Request.................................10 130 9.1.2 Send-Notifications Response................................13 131 9.2NOTIFICATION PROTOCOL URI SCHEME................................14 133 10 Status Codes.....................................................15 134 10.1 ADDITIONAL STATUS CODES.......................................15 135 10.1.1 successful-ok-ignored-notifications (0x0004)..............15 136 10.2 STATUS CODES RETURNED IN EVENT NOTIFICATION ATTRIBUTES GROUPS.15 137 10.2.1 client-error-not-found (0x0406)...........................15 138 10.2.2 successful-ok-but-cancel-subscription (0x0006)............16 140 11 Encoding and Transport...........................................16 141 11.1 ENCODING OF THE OPERATION LAYER...............................16 142 11.2 ENCODING OF TRANSPORT LAYER...................................16 144 12 IANA Considerations..............................................16 146 13 Internationalization Considerations..............................16 148 14 Security Considerations..........................................17 149 14.1 SECURITY CONFORMANCE..........................................17 151 15 References.......................................................17 153 16 Author's Addresses...............................................18 155 Expires: January 6, 2001 156 17 Full Copyright Statement.........................................18 158 Tables 160 Table 1 - Summary of the 'indp' Delivery Method.......................6 162 Table 2 . Operation-id assignments....................................9 164 Table 3 . Attributes in Event Notification Content...................11 166 Table 4 . Additional Attributes in Event Notification Content for Job 167 Events............................................................12 169 Table 5 . Combinations of Events and Subscribed Events for .job- 170 impressions-completed............................................13 172 Table 6 . Additional Attributes in Event Notification Content for 173 Printer Events...................................................13 175 Expires: January 6, 2001 177 1 Introduction 179 The notification extension document [ipp-ntfy] defines operations that a 180 client can perform in order to create Subscription Objects in a Printer 181 and carry out other operations on them. A Subscription Object represents 182 a Subscription abstraction. The Subscription Object specifies that when 183 one of the specified Events occurs, the Printer sends an asynchronous 184 Event Notification to the specified Notification Recipient via the 185 specified Delivery Method (i.e., protocol). 187 The notification extension document [ipp-ntfy] specifies that each 188 Delivery Method is defined in another document. This document is one 189 such document, and it specifies the .indp. Delivery Method. 191 For the .indp. Delivery Method, an IPP Printer sends (pushes) a Send- 192 Notifications operation request containing one or more Event 193 Notifications to a Notification Recipient. The Notification Recipient 194 returns a response to the Printer. The Send-Notifications operation 195 uses the same Encoding and Transport as IPP itself. 197 2 Terminology 199 This document uses terms such as "attributes", "keywords", and 200 "support". These terms have special meaning and are defined in the 201 model terminology [ipp-mod] section 12.2. 203 Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, 204 MAY, NEED NOT, and OPTIONAL, have special meaning relating to 205 conformance. These terms are defined in [ipp-mod] section 12.1 on 206 conformance terminology, most of which is taken from RFC 2119 [RFC2119]. 208 This document uses the capitalized terms, such as Notification 209 Recipient, Event Notification, Printer, etc., that are defined in [ipp- 210 ntfy] with the same meanings and are not reproduced here. 212 This section defines the following additional terms that are used 213 throughout this document: 215 Event Notification Attributes Group . The attributes group in a 216 request that contains Event Notification Attributes in a request or 217 response. 219 3 Model and Operation 221 See [ipp-ntfy] for the description of the Event Notification Model and 222 Operation. This Delivery Method takes advantage of combining several 223 Event Notifications into a single Compound Event Notification that is 224 delivery by a single Send-Notification operation to a single 225 Notification Recipient. 227 Expires: January 6, 2001 228 When creating each Subscription object, the client supplies the "notify- 229 recipient" (uri) Subscription Template attribute. The "notify- 230 recipient" attribute specifies both a single Notification Recipient that 231 is to receive the Notifications when subsequent events occur and the 232 method for notification delivery that the IPP Printer is to use. For 233 the Notification Delivery Method defined in this document, the 234 notification method is 'indp' and the rest of the URI is the address of 235 the Notification Recipient to which the IPP Printer will send the Send- 236 Notifications operation. 238 The 'indp' Notification Delivery Method defined in this document uses a 239 client/server protocol paradigm. The "client" in this relationship is 240 the Printer described in [ipp-ntfy] while the "server" is the 241 Notification Recipient. The Printer invokes the Send-Notifications 242 operation to communicate IPP Event Notification contents to the 243 Notification Recipient. The Notification Recipient only conveys 244 information to the Printer in the form of responses to the operations 245 initiated by the Printer. 247 Printers that implement the 'indp' Notification Delivery Method will 248 need to include an HTTP client stack while Notification Recipients that 249 implement this Delivery Method will need to support an HTTP server 250 stack. See section 11.2 for more details. 252 4 Summary of the 'indp' Delivery Method 254 Column 1 of Table 1 lists the conformance requirements for Delivery 255 Method Documents as specified in [ipp-ntfy]. Column 2 indicates how 256 this Delivery Method Document meets each requirement: 258 Table 1 - Summary of the 'indp' Delivery Method 260 Document Method conformance 'indp' realization 261 requirement 263 1.MUST define a URL scheme indp 264 name for the Delivery Method. 266 2.MUST indicate whether the OPTIONAL 267 delivery method is REQUIRED or 268 OPTIONAL for an IPP Printer to 269 support if it supports Event 270 Notification. 272 3.MUST define the transport a complete HTTP stack [rfc2616] 273 and delivery protocol for the 274 Event Notification content that 275 a Printer MUST use, i.e., the 276 entire network stack. 278 4.MUST indicate whether or not yes, see section 9.1.1 279 several Event Notifications can 281 Expires: January 6, 2001 282 Document Method conformance 'indp' realization 283 requirement 285 be combined into a compound 286 Event Notification. 288 5.MUST describe how the initiated by the Printer (push) 289 Delivery Method is initiated, 290 i.e., is it initiated by the 291 receiving user (pull), or is it 292 initiated by the Printer 293 (push). 295 6.MUST indicate whether the Machine Consumable with the 296 Delivery Method is Machine "notify-text" attribute being 297 Consumable or Human Consumable. Human Consumable 299 7.MUST define the The representation and encoding 300 representation and encoding is the same as IPP. See 301 that a Printer MUST use for section 9.1.1 302 each value or piece of 303 information listed in [ipp- 304 ntfy] section 9 (9.1 for 305 Machine Consumable Event 306 Notification and/or section 9.2 307 for Human Consumable Event 308 Notification). 310 8.MUST specify for each See the Send-Notifications 311 attribute in [ipp-ntfy] section Request defined in section 312 9 whether a Printer MUST, 9.1.1 313 SHOULD, MAY, MUST NOT, SHOULD 314 NOT or NEED NOT send the 315 attribute in an Event 316 Notification content. 318 9.MUST define what frequently Frequently occurring Events 319 occurring Events MUST be NEED NOT be moderated because 320 moderated, if any, and whether the Delivery Method is an 321 the moderation mechanism is efficient one and because the 322 configurable. Also whether Printer can group multiple 323 Events are moderated by sending Event Notifications for the 324 one per time unit or one per same Notification Recipient 325 number of Events. into a single Send- 326 Notifications operations. 328 10. MUST discuss the latency Same as for IPP/1.0 or IPP/1.1 329 and reliability of the itself (see [ipp-mod]). 330 transport and delivery 331 protocol. 333 11. MUST discuss the security See section 14 334 aspects of the transport and 336 Expires: January 6, 2001 337 Document Method conformance 'indp' realization 338 requirement 340 delivery protocol, e.g., how it 341 is handled in firewalls. 343 12. MUST identify content They are the same as for 344 length restrictions, if any. IPP/1.0 and IPP/1.1 itself (see 345 [ipp-mod]). 347 13. MAY define additional A new Event Notifications 348 values or pieces of information attribute group (see section 349 that a Printer MUST, SHOULD or 11.1) and additional status 350 MAY send in a Notification codes for use in the response 351 content. (see section 10) 353 14. MAY define additional none defined 354 Subscription Template and/or 355 Subscription Description 356 attributes and the conformance 357 requirements thereof. 359 15. MAY define additional none defined 360 Printer Description attributes 361 and the conformance 362 requirements thereof. 364 The remaining sections of this document parallel the sections of [ipp- 365 ntfy]. 367 5 Subscription object attributes 369 This section defines the Subscription object conformance requirements 370 for Printers. 372 5.1 Subscription Template Attribute Conformance 374 The 'indp' Delivery Method has the same conformance requirements for 375 Subscription Template attributes as defined in [ipp-ntfy]. The 'indp' 376 Delivery Method does not define any addition Subscription Template 377 attributes. 379 5.2 Subscription Description Attribute Conformance 381 The 'indp' Delivery Method has the same conformance requirements for 382 Subscription Description attributes as defined in [ipp-ntfy]. The 383 'indp' Delivery Method does not define any addition Subscription 384 Description attributes. 386 Expires: January 6, 2001 387 6 Printer Description Attribute Conformance 389 The 'indp' Delivery Method has the same conformance requirements for 390 Printer Description attributes as defined in [ipp-ntfy]. The 'indp' 391 Delivery Method does not define any addition Printer Description 392 attributes. 394 7 New Values for Existing Printer Description Attributes 396 This section defines additional values for existing Printer Description 397 attributes. 399 7.1 notify-schemes-supported (1setOf uriScheme) 401 The following .notify-schemes-supported. value is added in order to 402 support the new Delivery Method defined in this document: 404 'indp': - The IPP Notification Delivery Method defined in this 405 document. 407 7.2 operations-supported (1setOf type2 enum) 409 Table 2 lists the .operation-id. value added in order to support the new 410 operation defined in this document. The operation-id is assigned in the 411 same name space as other operations that a Printer supports. However, a 412 Printer MUST NOT include this value in its "operations-supported" 413 attribute unless it can accept the Send-Notifications request. 415 Table 2 . Operation-id assignments 417 Value Operation Name 419 0x001D Send-Notifications 421 8 Attributes Only in Event Notifications 423 No additional attributes are defined only for use in Event Notifications 424 besides those defined in [ipp-ntfy]. 426 9 Operations for Notification 428 This section defines the operation for Event Notification using the 429 'indp' Delivery Method. 431 There is only one operation defined: Send-Notifications. Section 7.2 432 assigns of the .operation-id. for the Send-Notifications operation and 433 the following section defined the operation. 435 Expires: January 6, 2001 436 9.1 Send-Notifications operation 438 This REQUIRED operation allows a Printer to send one or more Event 439 Notifications to a Notification Recipient using HTTP. 441 The Printer composes the information defined for an IPP Notification 442 [ipp-ntfy] and sends it using the Sent-Notifications operation to the 443 Notification Recipient supplied in the Subscription object. 445 The Send-Notifications operations uses the operations model defined by 446 IPP [rfc2566]. This includes, the use of a URI as the identifier for 447 the target of each operation, the inclusion of a version number, 448 operation-id, and request-id in each request, and the definition of 449 attribute groups. The Send-Notifications operation uses the Operation 450 Attributes group, but currently has no need for the Unsupported 451 Attributes, Printer Object Attributes, and Job-Object Attributes groups. 452 However, it uses a new attribute group, the Event Notification 453 Attributes group. 455 The Notification Recipient MUST accept the request in any state. There 456 is no state defined for the Notification Recipient for this Delivery 457 Method. 459 Access Rights: To send Event Notifications to a Notification Recipient, 460 the authenticated user (see [IPP-MOD] section 8.3) performing this 461 operation MUST be the Printer that accepted a previous Subscription 462 Creation operation (see [ipp-ntfy]). Otherwise the Notification 463 Recipient MUST reject the operation and return: the .client-error- 464 forbidden., .client-error-not-authenticated., or .client-error-not- 465 authorized. status code as appropriate. 467 ISSUE 01: Is this what the Access Rights section should say for a Send- 468 Notifications request? 470 9.1.1 Send-Notifications Request 472 Every operation request MUST contains the following parameters (see 473 [ipp-mod] section 3.1.1): 475 - a "version-number" ISSUE 02: What version number goes here? 476 - an "operation-id" - the value defined in Table 2 477 - a "request-id" - the contents of the Subscription object's 478 "notify-sequence-number" after incrementing for the first try 479 (see [ipp-ntfy]). 481 The following groups of attributes MUST be part of the Send- 482 Notifications Request: 484 Group 1: Operation Attributes 485 Natural Language and Character Set: 487 Expires: January 6, 2001 488 The "attributes-charset" and "attributes-natural-language" 489 attributes as defined in [ipp-mod] section 3.1.4.1. 491 Target: 492 A copy of the Subscription object's "notification-recipient- 493 uri" (uri) attribute which is the target of this operation as 494 described in [ipp-mod] section 3.1.5, i.e., the URI of the 495 'indp' Notification Recipient (see section 9.2). 497 Requesting User Name: 498 Unlike the other IPP operations, the .requesting-user-name. 499 attribute SHOULD NOT be supplied by the client as described in 500 [ipp-mod] section 8.3. 501 ISSUE 03: Ok that "requesting-user-name" SHOULD NOT be send 502 in Send-Notifications? 504 Group 2 to N: Event Notification Attributes 506 In each group 2 to N, each attribute is encoded using the IPP rules 507 for encoding attributes [ipp-pro] and may be encoded in any order. 508 Note: the Get-Jobs response in [ipp-mod] acts as a model for 509 encoding multiple groups of attributes. 511 Each Event Notification Group MUST contain all of attributes 512 specified in [ipp-ntfy] section 9.1 (.Content of Machine Consumable 513 Event Notifications.) with exceptions denoted by asterisks in the 514 tables below. 516 The tables below are copies of the tables in [ipp-ntfy] section 9.1 517 (.Content of Machine Consumable Event Notifications.) except that 518 each cell in the .Sends. column is a .MUST.. 520 For an Event Notification for all Events, the Printer sends the 521 following attributes. 523 Table 3 . Attributes in Event Notification Content 525 Source Value Sends Source Object 527 notify-subscription-id (integer(1:MAX)) MUST Subscription 529 notify-printer-uri (uri) MUST Subscription 531 notify-subscribed-event (type2 keyword) MUST Event 532 Notification 534 printer-up-time (integer(MIN:MAX)) MUST Printer 536 printer-current-time (dateTime) * MUST Printer 538 notify-sequence-number (integer (0:MAX)) MUST Subscription 540 notify-charset (charset) MUST Subscription 542 Expires: January 6, 2001 543 Source Value Sends Source Object 545 notify-natural-language (naturalLanguage) MUST Subscription 547 notify-user-data (octetString(63)) ** MUST Subscription 549 notify-text (text) MUST Event 550 Notification 552 attributes from the .notify-attributes. MUST Printer 553 attribute *** 555 attributes from the .notify-attributes. MUST Job 556 attribute *** 558 attributes from the .notify-attributes. MUST Subscription 559 attribute *** 561 ISSUE 04: Ok that "notify-text" has been changed from MAY to MUST? 563 * The Printer MUST send .printer-current-time. if and only if it 564 supports the .printer-current-time. attribute on the Printer 565 object. 567 ** If the associated Subscription Object does not contain a 568 .notify-user-data. attribute, the Printer MUST send an octet-string 569 of length 0. 571 *** If the .notify-attributes. attribute is present on the 572 Subscription Object, the Printer MUST send all attributes specified 573 by the .notify-attributes. attribute. Note: if the Printer doesn.t 574 support the .notify-attributes. attribute, it is not present on the 575 associated Subscription Object. 577 For Event Notifications for Job Events, the Printer sends the 578 following additional attributes shown in Table 4. 580 Table 4 . Additional Attributes in Event Notification Content for 581 Job Events 583 Source Value Sends Source Object 585 job-id (integer(1:MAX)) MUST Job 587 job-state (type1 enum) MUST Job 589 job-state-reasons (1setOf type2 keyword) MUST Job 591 job-impressions-completed MUST Job 592 (integer(0:MAX)) * 594 Expires: January 6, 2001 595 * The Printer MUST send the .job-impressions-completed. attribute 596 in an Event Notification only for the combinations of Events and 597 Subscribed Events shown in Table 5. 599 Table 5 . Combinations of Events and Subscribed Events for .job- 600 impressions-completed. 602 Job Event Subscribed Job Event 604 .job-progress. .job-progress. 606 .job-completed. .job-completed. 608 .job-completed. .job-state-changed. 610 For Event Notification for Printer Events, the Printer sends the 611 following additional attributes shown in Table 6. 613 Table 6 . Additional Attributes in Event Notification Content for 614 Printer Events 616 Source Value Sends Source Object 618 printer-state (type1 enum) MUST Printer 620 printer-state-reasons (1setOf type2 MUST Printer 621 keyword) 623 printer-is-accepting-jobs (boolean) MUST Printer 625 9.1.2 Send-Notifications Response 627 The Notification Recipient MUST return (to the client which is the 628 Printer) the following sets of attributes as part of a Send- 629 Notifications response: 631 Every operation response contains the following REQUIRED parameters (see 632 [ipp-mod] section 3.1.1}: 634 - a "version-number" 635 - a "status-code" 636 - the "request-id" that was supplied in the corresponding request 638 Group 1: Operation Attributes 640 Status Message: 641 As defined in [ipp-mod]. 643 Expires: January 6, 2001 644 The Notification Recipient can return any status codes defined in 645 [ipp-mod] and section 10.1 that applies to all of the Event 646 Notification Attribute groups. The following is a description of 647 the important status codes: 649 'successful-ok': the Notification Recipient received all of the 650 Event Notification Attribute Groups and was expecting each of 651 them. 652 'successful-ok-ignored-notifications': the Notification 653 Recipient was able to consume some, but not all of the Event 654 Notification Attributes Groups sent. The Event Notification 655 Attributes Groups with a .notify-status-code. attribute are 656 the ones that were ignored or are to be canceled. 657 'client-error-ignored-all-notifications': the Notification 658 Recipient was unable to consume any of the Event Notification 659 Attributes Groups sent. The Event Notification Attributes 660 Groups with a .notify-status-code. attribute are the ones that 661 were ignored or are to be canceled. 663 Natural Language and Character Set: 664 The "attributes-charset" and "attributes-natural-language" 665 attributes as defined in [ipp-mod] section 3.1.4.1. 667 Group 2 to N: Notification Attributes 669 These groups MUST be returned if and only if the "status-code" 670 parameter returned in Group 1 is anything but the 'successful-ok' 671 status code. 673 "notification-status-code" (type2 enum) 674 Indicates whether the Notification Recipient was able to consume 675 the n-th Notification Report as follows: 677 'successful-ok' - this Event Notification Attribute Group was 678 consumed 679 'client-error-not-found' - this Event Notification Attribute Group 680 was not able to be consumed. The Printer MUST cancel the 681 Subscription and MUST NOT attempt to send any further Event 682 Notifications from the associated Subscription object. 683 'successful-ok-but-cancel-subscription' - the Event Notification 684 Attribute Group was consumed, but the Notification Recipient 685 wishes to cancel the Subscription object. The Printer MUST 686 cancel the Subscription and MUST NOT attempt to send any further 687 Event Notifications from the associated Subscription object. 689 9.2 Notification Protocol URI Scheme 691 The INDP Notification Delivery Method uses the 'indp://' URI scheme in 692 the "notify-recipients" attribute in the Subscription object in order to 693 indicate the notification Delivery Method defined in this document. The 694 remainder of the URI indicates the host and address of the Notification 695 Recipient that is to receive the Send-Notification operation. 697 Expires: January 6, 2001 698 10 Status Codes 700 This section lists status codes whose meaning have been extended and/or 701 defined for returning in Event Notification Attribute Groups as the 702 value of the "notification-status-code" operation attribute. The code 703 values are allocated in the same space as the status codes in [ipp-mod]. 705 10.1 Additional Status Codes 707 The following status codes are defined as extensions for Notification 708 and are returned as the value of the .status-code. parameter in the 709 Operation Attributes Group of a response (see [ipp-mod] section 710 3.1.6.1). Operations in this document can also return the status codes 711 defined in section 13 of [ipp-mod]. The .successful-ok. status code is 712 an example of such a status code. 714 10.1.1 successful-ok-ignored-notifications (0x0004) 716 The Notification Recipient was able to consume some, but not all, of the 717 Event Notifications Attributes Groups sent by the Printer in the Send- 718 Notifications request. See section 9.1.2 for further details. 720 10.2 Status Codes returned in Event Notification Attributes Groups 722 This section contains values of the .notify-status-code. attribute that 723 the Notification Recipient returns in a Event Notification Attributes 724 Group in a response when the corresponding Event Notification Attributes 725 Group in the request: 727 1. was not consumed OR 729 2. was consumed, but the Notification Recipient wants to cancel the 730 corresponding Subscription object 732 The following sections are ordered in decreasing order of importance of 733 the status-codes. 735 10.2.1 client-error-not-found (0x0406) 737 This status code is defined in [ipp-mod]. This document extends its 738 meaning and allows it to be returned in an Event Notification Attributes 739 Group of a response. 741 The Notification Recipient was unable to consume this Event Notification 742 Attributes Group because it was not expected. See section 9.1.2 for 743 further details. 745 Expires: January 6, 2001 746 10.2.2 successful-ok-but-cancel-subscription (0x0006) 748 The Notification Recipient was able to consume this Event Notification 749 Attributes Group that the Printer sent, but wants the corresponding 750 Subscription object to be canceled none-the-less. See section 9.1.2 for 751 further details. 753 11 Encoding and Transport 755 This section defines the encoding and transport used by the 'indp' 756 Delivery Method. 758 11.1 Encoding of the Operation Layer 760 The 'indp' Delivery Method uses the IPP operation layer encoding 761 described in [ipp-pro] and the following Event Notification Attributes 762 Group tag allocated by [ipp-ntfy]: 764 Tag Value (Hex) Meaning 766 0x07 .event-notification-attributes-tag. 768 11.2 Encoding of Transport Layer 770 The 'indp' Notification Delivery Method uses the IPP transport layer 771 encoding described in [ipp-pro]. 773 It is REQUIRED that an 'indp' Notification Recipient implementation 774 support HTTP over the IANA assigned Well Known Port assigned to the 775 'indp' Delivery Method as its default port by IANA (see section 12), 776 though a Notification Recipient implementation MAY support HTTP over 777 some other port as well. 779 12 IANA Considerations 781 The 'indp://' URL scheme for the 'indp' Delivery Method will be 782 registered with IANA. IANA will assign a default port to use with the 783 'indp' Delivery Method. 785 13 Internationalization Considerations 787 When the client requests Human Consumable form by supplying the "notify- 788 text-format" operation attribute (see [ipp-ntfy]), the IPP Printer (or 789 any Notification Service that the IPP Printer might be configured to 790 use) supplies and localizes the text value of the "human-readable- 791 report" attribute in the Notification according to the charset and 792 natural language requested in the notification subscription. 794 Expires: January 6, 2001 795 14 Security Considerations 797 The IPP Model and Semantics document [ipp-mod] discusses high level 798 security requirements (Client Authentication, Server Authentication and 799 Operation Privacy). Client Authentication is the mechanism by which the 800 client proves its identity to the server in a secure manner. Server 801 Authentication is the mechanism by which the server proves its identity 802 to the client in a secure manner. Operation Privacy is defined as a 803 mechanism for protecting operations from eavesdropping. 805 The Notification Recipient can cancel unwanted Subscriptions created by 806 other parties without having to be the owner of the subscription by 807 returning the 'successful-ok-but-cancel-subscription' status code in the 808 Send-Notifications response returned to the Printer. 810 14.1 Security Conformance 812 Printers (client) MAY support Digest Authentication [rfc2617]. If 813 Digest Authentication is supported, then MD5 and MD5-sess MUST be 814 supported, but the Message Integrity feature NEED NOT be supported. 816 Notification Recipient (server) MAY support Digest Authentication 817 [rfc2617]. If Digest Authentication is supported, then MD5 and MD5-sess 818 MUST be supported, but the Message Integrity feature NEED NOT be 819 supported. 821 Notification Recipients MAY support TLS for client authentication, 822 server authentication and operation privacy. If a Notification Recipient 823 supports TLS, it MUST support the TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA 824 cipher suite as mandated by RFC 2246 [rfc2246]. All other cipher suites 825 are OPTIONAL. Notification recipients MAY support Basic Authentication 826 (described in HTTP/1.1 [rfc2616]) for client authentication if the 827 channel is secure. TLS with the above mandated cipher suite can provide 828 such a secure channel. 830 15 References 832 [indp] 833 Parra, H., T. Hastings, "Internet Printing Protocol (IPP): IPP 834 Notification Delivery Protocol (INDP)", , 835 February 29, 2000. 837 [ipp-mod] 838 R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell, 839 "Internet Printing Protocol/1.0: Model and Semantics", , May 22, 2000. 842 [ipp-ntfy] 843 Isaacson, S., Martin, J., deBry, R., Hastings, T., Shepherd, M., 844 Bergman, R., "Internet Printing Protocol/1.1: IPP Event 845 Notification Specification", , June 846 30, 2000. 848 Expires: January 6, 2001 850 [ipp-pro] 851 Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing 852 Protocol/1.1: Encoding and Transport", draft-ietf-ipp-protocol-v11- 853 06.txt, May 30, 2000. 855 [rfc2026] 856 S. Bradner, "The Internet Standards Process -- Revision 3", RFC 857 2026, October 1996. 859 [rfc2616] 860 R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. 861 Leach, T. Berners-Lee, "Hypertext Transfer Protocol - HTTP/1.1", 862 RFC 2616, June 1999. 864 [rfc2617] 865 J. Franks, P. Hallam-Baker, J. Hostetler, S. Lawrence, P. Leach, A. 866 Luotonen, L. Stewart, "HTTP Authentication: Basic and Digest Access 867 Authentication", RFC 2617, June 1999. 869 16 Author's Addresses 871 Hugo Parra 872 Novell, Inc. 873 1800 South Novell Place 874 Provo, UT 84606 876 Phone: 801-861-3307 877 Fax: 801-861-2517 878 e-mail: hparra@novell.com 880 Tom Hastings 881 Xerox Corporation 882 737 Hawaii St. ESAE 231 883 El Segundo, CA 90245 885 Phone: 310-333-6413 886 Fax: 310-333-5514 887 e-mail: hastings@cp10.es.xerox.com 889 17 Full Copyright Statement 891 Copyright (C) The Internet Society (2000). All Rights Reserved. 893 This document and translations of it may be copied and furnished to 894 others, and derivative works that comment on or otherwise explain it or 895 assist in its implementation may be prepared, copied, published and 896 distributed, in whole or in part, without restriction of any kind, 897 provided that the above copyright notice and this paragraph are included 898 on all such copies and derivative works. However, this document itself 899 may not be modified in any way, such as by removing the copyright notice 900 or references to the Internet Society or other Internet organizations, 901 except as needed for the purpose of developing Internet standards in 903 Expires: January 6, 2001 904 which case the procedures for copyrights defined in the Internet 905 Standards process must be followed, or as required to translate it into 906 languages other than English. 908 The limited permissions granted above are perpetual and will not be 909 revoked by the Internet Society or its successors or assigns. 911 This document and the information contained herein is provided on an "AS 912 IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK 913 FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT 914 LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT 915 INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR 916 FITNESS FOR A PARTICULAR PURPOSE. 918 Expires: January 6, 2001