User Defined Resource Error HTTP Status Code
draft-divilly-user-defined-resource-error-00

Document Type Active Internet-Draft (individual)
Last updated 2020-03-26
Replaces draft-divilly-status-555
Stream (None)
Intended RFC status (None)
Formats plain text html xml pdf htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                         C. Divilly
Internet-Draft                                                    Oracle
Intended status: Informational                             26 March 2020
Expires: 27 September 2020

              User Defined Resource Error HTTP Status Code
              draft-divilly-user-defined-resource-error-00

Abstract

   This document specifies an additional HyperText Transfer Protocol
   (HTTP) status code to indicate server error conditions arising during
   evaluation of a user defined resource hosted by the server, rather
   than in the server itself.

Conventions and Terminology

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in RFC 2119 [RFC2119].

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on 27 September 2020.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://trustee.ietf.org/
   license-info) in effect on the date of publication of this document.
   Please review these documents carefully, as they describe your rights

Divilly                 Expires 27 September 2020               [Page 1]
Internet-Draft   User Defined Resource Error Status Code      March 2020

   and restrictions with respect to this document.  Code Components
   extracted from this document must include Simplified BSD License text
   as described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Simplified BSD License.

Table of Contents

   1.  Note to Readers . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     2.1.  Why does 500 Internal Server Error not suffice? . . . . .   2
   3.  5NN User Defined Resource Error . . . . . . . . . . . . . . .   4
     3.1.  Relationship to 500 Internal Server Error . . . . . . . .   4
   4.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   5
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   6.  Example . . . . . . . . . . . . . . . . . . . . . . . . . . .   6
   7.  Normative References  . . . . . . . . . . . . . . . . . . . .   6
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   7

1.  Note to Readers

   Per [RFC7231] Section 8.2.2 (https://tools.ietf.org/html/
   rfc7231#section-8.2.2) this document avoids allocating a specific
   number for the proposed new HTTP status code until there is clear
   consensus that it will be registered.  The code "5NN" is used
   throughout this document to denote this new status code.

2.  Introduction

   Some HTTP servers offer mechanisms for users to define their own
   programmatically generated resources.  This specification terms such
   a resource as a 'User Defined Resource'.  In such cases it is useful
   to distinguish between errors arising due to defects in the User
   Defined Resource and errors arising due to defects in the server
   itself.

   This document proposes a new 5NN HTTP status code.  This status code
   indicates that an error occurred when the server attempted to produce
   a representation of the User Defined Resource, and the error occurred
   when attempting to evaluate the program that generates the resource,
   rather than an error condition in the server itself.

2.1.  Why does 500 Internal Server Error not suffice?

   This section is non normative.

   The current state of the art is to represent errors in User Defined
   Resources as a 500 Internal Server Error status.  In the author's
   experience this is not optimal for the following reasons:

Divilly                 Expires 27 September 2020               [Page 2]
Internet-Draft   User Defined Resource Error Status Code      March 2020

   *  It is widely understood that a 500 Internal Server Error
      represents a serious error condition that likely needs remediation
      by the server's operators

   *  Error conditions in User Defined Resources are frequent and
      expected.  In a well architected system with isolation between the
Show full document text