RFC 4329

Scripting Media Types

πŸ“… published April 2006, from ietf

RFC 4329: Scripting Media Types πŸŽ€

Okay bestie, RFC 4329 is called Scripting Media Types πŸ’– It was written by B. Hoehrmann and is dated April 2006. It's in the Informational category 🌸 The header doesn't list anything it obsoletes or updates, so there's no lineage to trace there ✨


Status of This Memo πŸ“‹

This memo provides information for the Internet community. It does not specify an Internet standard of any kind. Distribution of this memo is unlimited.

Copyright (C) The Internet Society (2006).

Abstract 🌟

This document describes the registration of media types for the ECMAScript and JavaScript programming languages and conformance requirements for implementations of these types.

Table of Contents πŸ“‘

1. Introduction ....................................................2
2. Conformance and Document Conventions ............................2
3. Deployed Scripting Media Types and Compatibility ................2
4. Character Encoding Scheme Handling ..............................4
   4.1. Charset Parameter ..........................................4
   4.2. Character Encoding Scheme Detection ........................4
   4.3. Character Encoding Scheme Error Handling ...................6
5. Security Considerations .........................................6
6. IANA Considerations .............................................8
7. JavaScript Media Types ..........................................9
   7.1. text/javascript (obsolete) .................................9
   7.2. application/javascript ....................................10
8. ECMAScript Media Types .........................................11
   8.1. text/ecmascript (obsolete) ................................11
   8.2. application/ecmascript ....................................12
9. References .....................................................13
   9.1. Normative References ......................................13
   9.2. Informative References ....................................13

1. Introduction ✨

So this memo is all about media types for JavaScript and ECMAScript πŸ’… If you want the backstory on these languages, go check out "Brief History" and "Overview" in [ECMA] πŸ¦‹

Programs written in these languages have historically been passed around using media types that were inapplicable, experimental, or never registered at all πŸ’€ This document defines four of the most commonly used media types for those programs. The goal is to get them into the IANA media type registry πŸ“š, to help interoperability by pinning down the parts that were underspecified 🫢, and to give general security considerations πŸ”’

2. Conformance and Document Conventions πŸ‘‘

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 BCP 14, [RFC2119] and indicate requirement levels for compliant implementations. Requirements apply to all implementations unless otherwise stated. πŸŽ€

An implementation is a software module that supports one of the media types defined in this document. A software module can support multiple media types, but conformance is judged separately for each type 🌈

Implementations that fail to satisfy one or more "MUST" requirements are considered non-compliant πŸ™ˆ Implementations that satisfy all "MUST" requirements but fail to satisfy one or more "SHOULD" requirements are said to be "conditionally compliant" πŸ’œ All other implementations are "unconditionally compliant" ⭐

3. Deployed Scripting Media Types and Compatibility 🧚

Various unregistered media types have been used in an ad-hoc way to label and exchange programs written in ECMAScript and JavaScript 😭 These include:

    +-----------------------------------------------------+
    | text/javascript          | text/ecmascript          |
    | text/javascript1.0       | text/javascript1.1       |
    | text/javascript1.2       | text/javascript1.3       |
    | text/javascript1.4       | text/javascript1.5       |
    | text/jscript             | text/livescript          |
    | text/x-javascript        | text/x-ecmascript        |
    | application/x-javascript | application/x-ecmascript |
    | application/javascript   | application/ecmascript   |
    +-----------------------------------------------------+

Using the "text" top-level type for this kind of content is known to be problematic πŸ™ƒ So this document defines text/javascript and text/ecmascript but marks them as "obsolete" πŸ₯€ Using the experimental and unregistered types from the list above is discouraged 🚫 The media types below are also defined in this document, are meant for common use, and should be used instead ✨

  • application/javascript
  • application/ecmascript

This document defines equivalent processing requirements for text/javascript, text/ecmascript, and application/javascript πŸ’– Use of and support for application/ecmascript is considerably less widespread than for the other media types defined here. Taking advantage of that, this document defines stricter processing rules for this type so processing can be more interoperable πŸ‘‘

The types defined in this document apply to scripts written in [JS15] and [ECMA], respectively, and also to scripts written in a compatible language or profile such as [EcmaCompact] 🌸

This document does not address scripts written in other languages πŸ™…β€β™€οΈ Future versions of JavaScript, future editions of [ECMA], and extensions to [ECMA] such as [E4X] are not directly addressed here. This document may be updated to take other content into account πŸ¦‹

Updates of this document may introduce new optional parameters, and implementations MUST consider the impact of such an update 🫒 For the application/ecmascript media type, implementations MUST NOT process content labeled with a version parameter as if no such parameter had been specified. This is typically done by treating the content as unsupported 🚧 This error handling behavior lets the definition of the media type be extended for content that implementations of [ECMA] cannot process 🧁

The programming languages defined in [JS15] and [ECMA] share a common subset. Choosing a type for scripts that are compatible with both languages is out of scope for this document 🌈

This document does not define how fragment identifiers in resource identifiers ([RFC3986], [RFC3987]) are resolved for documents labeled with one of the media types defined here πŸ” An update of this document may define processing of fragment identifiers πŸŽ€

4. Character Encoding Scheme Handling πŸ”€

Refer to [RFC3536] for a discussion of the terminology used in this section πŸ“– Source text (as defined in [ECMA], section 6) can be binary source text. Binary source text is a textual data object that represents source text encoded using a character encoding scheme. A textual data object is a whole text protocol message or a whole text document, or a part of one, that is treated separately for purposes of external storage and retrieval. An implementation's internal representation of source text, and source text itself, are not considered binary source text 🧠

Implementations need to determine a character encoding scheme in order to decode binary source text into source text. The media types defined in this document allow an optional charset parameter to explicitly specify the character encoding scheme used to encode the source text πŸ’…

How implementations determine the character encoding scheme can be subject to processing rules that are out of scope for this document 🌍 For example, transport protocols can require that a specific character encoding scheme is assumed when the optional charset parameter is not specified, or they can require that the charset parameter is used in certain cases. Those requirements are not considered part of this document πŸ™ˆ

Implementations that support binary source text MUST support binary source text encoded using the UTF-8 [RFC3629] character encoding scheme. Other character encoding schemes MAY be supported. Using UTF-8 to encode binary source text is encouraged but not required 🫢

4.1. Charset Parameter 🏷️

The charset parameter is how you specify the character encoding scheme of binary source text πŸŽ€ Its value MUST match the mime-charset production defined in [RFC2978], section 2.3, and SHOULD be a registered charset [CHARSETS] πŸ’œ An illegal value is one that does not match that production 🚫

4.2. Character Encoding Scheme Detection πŸ•΅οΈβ€β™€οΈ

Sometimes implementations cannot interoperably determine a single character encoding scheme just by complying with all the requirements of the applicable specifications 😭 To help interoperability in those cases, the following algorithm is defined 🌸

Implementations apply this algorithm until a single character encoding scheme is determined ✨

  1. If a charset parameter with a legal value is specified, that value determines the character encoding scheme πŸ’–
  2. If the binary source text starts with a Unicode encoding form signature, the signature determines the encoding. The following octet sequences, at the very beginning of the binary source text, are considered with their corresponding character encoding schemes:
    +------------------+----------+
    | Leading sequence | Encoding |
    +------------------+----------+
    | FF FE 00 00      | UTF-32LE |
    | 00 00 FE FF      | UTF-32BE |
    | FF FE            | UTF-16LE |
    | FE FF            | UTF-16BE |
    | EF BB BF         | UTF-8    |
    +------------------+----------+

The longest matching octet sequence determines the encoding. Implementations of this step MUST use these octet sequences to determine the character encoding scheme, even if the determined scheme is not supported πŸ™Œ If this step determines the character encoding scheme, the octet sequence representing the Unicode encoding form signature MUST be ignored when decoding the binary source text to source text 🫧

  1. The character encoding scheme is determined to be UTF-8 🌈

If the character encoding scheme is determined to be UTF-8 through any means other than step 2 above, and the binary source text starts with the octet sequence EF BB BF, that octet sequence is ignored when decoding the binary source text to source text. (The sequence is also ignored if step 2 determines the character encoding scheme, per the requirements in step 2.) 🧼

In the case described above, implementations of the types text/javascript, text/ecmascript, and application/javascript SHOULD implement the requirements defined in this section, and implementations of the type application/ecmascript MUST implement them πŸ’… Bestie, that's the detection story, and the application/ecmascript type is the strict one πŸ‘‘

4.3. Character Encoding Scheme Error Handling ✨

okay so this section is all about what happens when the encoding goes wrong 😭 The following error processing behavior is RECOMMENDED for text/javascript, text/ecmascript, and application/javascript, and REQUIRED for application/ecmascript πŸ’…

  • If the value of a charset parameter is illegal, implementations MUST either recover from the error by ignoring the parameter or consider the character encoding scheme unsupported. πŸ™ˆ
  • If binary source text is determined to have been encoded using a certain character encoding scheme that the implementation is unable to process, implementations MUST consider the resource unsupported (i.e., they MUST NOT decode the binary source text using a different character encoding scheme). πŸ’€
  • Binary source text can be determined to have been encoded using a certain character encoding scheme but contain octet sequences that are not legal according to that scheme. This is typically caused by a lack of proper character encoding scheme information; such errors can pose a security risk, as discussed in section 5. πŸ”₯

Okay the last bullet is the big one πŸ‘‘ Implementations SHOULD detect such errors as early as possible; in particular, they SHOULD detect them before interpreting any of the source text. Implementations MUST detect such errors and MUST NOT interpret any source text after detecting such an error. Such errors MAY be reported, e.g., as syntax errors as defined in [ECMA], section 16. ✨

This document does not define facilities that allow specification of the character encoding scheme used to encode binary source text in a conflicting manner. There are only two sources for character encoding scheme information: the charset parameter and the Unicode encoding form signature. If a charset parameter is specified, binary source text is processed as defined for that character encoding scheme. πŸ¦‹


5. Security Considerations πŸ”

Okay, security time, and I'm being so serious about it 🫢 Refer to [RFC3552] for a discussion of terminology used in this section. Examples in this section and discussions of interactions of host environments with scripts and extensions to [ECMA] are to be understood as non-exhaustive and of a purely illustrative nature.

The programming language defined in [ECMA] is not intended to be computationally self-sufficient, rather it is expected that the computational environment provides facilities to programs to enable specific functionality. Such facilities constitute unknown factors and are thus considered out of the scope of this document. 🧚

Derived programming languages are permitted to include additional functionality that is not described in [ECMA]; such functionality constitutes an unknown factor and is thus considered out of the scope of this document. In particular, extensions to [ECMA] defined for the JavaScript programming language are not discussed in this document.

Uncontrolled execution of scripts can be exceedingly dangerous. πŸ’€ Implementations that execute scripts MUST give consideration to their application's threat models and those of the individual features they implement; in particular, they MUST ensure that untrusted content is not executed in an unprotected environment. This is the part to really lock in πŸ”’

Specifications for host environment facilities and for derived programming languages should include security considerations. If an implementation supports such facilities, the respective security considerations apply. In particular, if scripts can be referenced from or included in specific document formats, the considerations for the embedding or referencing document format apply.

For example, scripts embedded in application/xhtml+xml [RFC3236] documents could be enabled through the host environment to manipulate the document instance, which could cause the retrieval of remote resources; security considerations regarding retrieval of remote resources of the embedding document would apply in this case. 🌸

This circumstance can further be used to make information, that is normally only available to the script, available to a web server by encoding the information in the resource identifier of the resource, which can further enable eavesdropping attacks. Implementation of such facilities is subject to the security considerations of the host environment, as discussed above. πŸ‘€

The facilities defined in [ECMA] do not include provisions for input of external data, output of computed results, or modification of aspects of the host environment. An implementation of only the facilities defined in [ECMA] is not considered to support dangerous operations. 🌈

The programming language defined in [ECMA] does include facilities to loop, cause computationally complex operations, or consume large amounts of memory; this includes, but is not limited to, facilities that allow dynamically generated source text to be executed (e.g., the eval() function); uncontrolled execution of such features can cause denial of service, which implementations MUST protect against. 🚨

A host environment can provide facilities to access external input. Scripts that pass such input to the eval() function or similar language features can be vulnerable to code injection attacks. Scripts are expected to protect against such attacks. πŸ™…β€β™€οΈ

A host environment can provide facilities to output computed results in a user-visible manner. For example, host environments supporting a graphical user interface can provide facilities that enable scripts to present certain messages to the user. Implementations MUST take steps to avoid confusion of the origin of such messages. In general, the security considerations for the host environment apply in such a case as discussed above. πŸŽ€

Implementations are required to support the UTF-8 character encoding scheme; the security considerations of [RFC3629] apply. Additional character encoding schemes may be supported; support for such schemes is subject to the security considerations of those schemes. πŸ’œ

Source text is expected to be in Unicode Normalization Form C. Scripts and implementations MUST consider security implications of unnormalized source text and data. For a detailed discussion of such implications refer to the security considerations in [RFC3629]. ⭐

Scripts can be executed in an environment that is vulnerable to code injection attacks. For example, a CGI script [RFC3875] echoing user input could allow the inclusion of untrusted scripts that could be executed in an otherwise trusted environment. This threat scenario is subject to security considerations that are out of the scope of this document. 😬

The "data" resource identifier scheme [RFC2397], in combination with the types defined in this document, could be used to cause execution of untrusted scripts through the inclusion of untrusted resource identifiers in otherwise trusted content. Security considerations of [RFC2397] apply. 🫣

Implementations can fail to implement a specific security model or other means to prevent possibly dangerous operations. Such failure could possibly be exploited to gain unauthorized access to a system or sensitive information; such failure constitutes an unknown factor and is thus considered out of the scope of this document. πŸ₯Ί


6. IANA Considerations πŸ—‚οΈ

This document registers four new media types as defined in the following sections. Four new ones, bestie πŸŽ‰


7. JavaScript Media Types 🌟

7.1. text/javascript (obsolete) πŸ•°οΈ

Type name:               text
Subtype name:            javascript
Required parameters:     none
Optional parameters:     charset, see section 4.1.
Encoding considerations:
   The same as the considerations in section 3.1 of [RFC3023].

Security considerations: See section 5.
Interoperability considerations:
   None, except as noted in other sections of this document.

Published specification: [JS15]
Applications which use this media type:
   Script interpreters as discussed in this document.

Additional information:

   Magic number(s):             n/a
   File extension(s):           .js
   Macintosh File Type Code(s): TEXT

Person & email address to contact for further information:
   See Author's Address section.

Intended usage:          OBSOLETE
Restrictions on usage:   n/a
Author:                  See Author's Address section.
Change controller:       The IESG.

7.2. application/javascript πŸ’–

Type name:               application
Subtype name:            javascript
Required parameters:     none
Optional parameters:     charset, see section 4.1.
Encoding considerations:
   The same as the considerations in section 3.2 of [RFC3023].

Security considerations: See section 5.
Interoperability considerations:
   None, except as noted in other sections of this document.

Published specification: [JS15]
Applications which use this media type:
   Script interpreters as discussed in this document.

Additional information:

   Magic number(s):             n/a
   File extension(s):           .js
   Macintosh File Type Code(s): TEXT

Person & email address to contact for further information:
   See Author's Address section.

Intended usage:          COMMON
Restrictions on usage:   n/a
Author:                  See Author's Address section.
Change controller:       The IESG.

8. ECMAScript Media Types πŸ¦„

8.1. text/ecmascript (obsolete) πŸ•°οΈ

Type name:               text
Subtype name:            ecmascript
Required parameters:     none
Optional parameters:     charset, see section 4.1.
Encoding considerations:
   The same as the considerations in section 3.1 of [RFC3023].

Security considerations: See section 5.
Interoperability considerations:
   None, except as noted in other sections of this document.

Published specification: [ECMA]
Applications which use this media type:
   Script interpreters as discussed in this document.

Additional information:

   Magic number(s):             n/a
   File extension(s):           .es
   Macintosh File Type Code(s): TEXT

Person & email address to contact for further information:
   See Author's Address section.

Intended usage:          OBSOLETE
Restrictions on usage:   n/a
Author:                  See Author's Address section.
Change controller:       The IESG.

8.2. application/ecmascript 🌷

Type name:               application
Subtype name:            ecmascript
Required parameters:     none
Optional parameters:     charset, see section 4.1.
Note: Section 3 defines error handling behavior for content labeled with a "version" parameter. πŸ“Œ
Encoding considerations:
   The same as the considerations in section 3.2 of [RFC3023].

Security considerations: See section 5.
Interoperability considerations:
   None, except as noted in other sections of this document.

Published specification: [ECMA]
Applications which use this media type:
   Script interpreters as discussed in this document.

Additional information:

   Magic number(s):             n/a
   File extension(s):           .es
   Macintosh File Type Code(s): TEXT

Person & email address to contact for further information:
   See Author's Address section.

Intended usage:          COMMON
Restrictions on usage:   n/a
Author:                  See Author's Address section.
Change controller:       The IESG.

9. References πŸ“š

9.1. Normative References

9.2. Informative References

Author's Address

Bjoern Hoehrmann
Weinheimer Strasse 22
Mannheim  D-68309
Germany

EMail: bjoern@hoehrmann.de
URI:   http://bjoern.hoehrmann.de
Note: Please write "Bjoern Hoehrmann" with o-umlaut (U+00F6) wherever possible, e.g., as Björn Höhrmann in HTML and XML. The name deserves its umlaut, bestie. πŸ™ˆ

Copyright (C) The Internet Society (2006). 🌈

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

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

Intellectual Property

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

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

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

Acknowledgement

Funding for the RFC Editor function is provided by the IETF Administrative Support Activity (IASA). πŸ’–

πŸ“¦ where this page comes from