Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add security and IANA considerations #88

Merged
merged 1 commit into from
Nov 29, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions versions/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -747,6 +747,73 @@ Field Pattern | Type | Description

The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced).

## <a name="securityConsiderations"></a>Security Considerations

The Workflows Specification does not enforce a security mechanism. Security is left to the implementer, though TLS, specifically HTTPS may be recommended for exchanging sensitive workflows.

Workflows can be JSON or YAML values. As such, all security considerations defined in [RFC 8259](https://www.rfc-editor.org/info/rfc8259) and within YAML version [1.2](https://yaml.org/spec/1.2/spec.html) apply.

Workflows are frequently written by untrusted third parties, to be deployed on public Internet servers. Processing a workflow description can cause both safe and unsafe operations to be performed on arbitrary network resources. It is the responsibility of the description consumer to ensure that the operations performed are not harmful.

## <a name="iANAConsiderations"></a>IANA Considerations

The proposed MIME media types for Workflows are described below.

### <a name="defaultMIMEType"></a>application/vnd.oai.workflows

The default (or general) MIME type for Workflows is defined as follows:

&emsp; Media type name: application

&emsp; Media subtype name: vnd.oai.workflows

&emsp; Required parameters: N/A

&emsp; Optional parameters: version (e.g. version=1.0.0 to indicate that the type of workflow conforms to version 1.0.0 of the Workflows Specification).

&emsp; Encoding considerations: Encoding considerations are identical to those specified for the `application/json` and `application/yaml` media types, respectively.

&emsp; Security considerations: See [security considerations](#security-considerations) above.

&emsp; Interoperability considerations: N/A

**Note:** When using the `application/vnd.oai.workflows` media type the consumer should be prepared to receive YAML formatted content

### <a name="jsonMIMEType"></a>application/vnd.oai.workflows+json

The proposed MIME media type for Workflows that require a JSON-specific media type is defined as follows:

&emsp; Media type name: application

&emsp; Media subtype name: vnd.oai.workflows+json

&emsp; Required parameters: N/A

&emsp; Optional parameters: version (e.g. version=1.0.0 to indicate that the type of workflow conforms to version 1.0.0 of the Workflows Specification).

&emsp; Encoding considerations: Encoding considerations are identical to those specified for the `application/json` media type.

&emsp; Security considerations: See [security considerations](#security-considerations) above.

&emsp; Interoperability considerations: N/A

### <a name="yamlMIMEType"></a>application/vnd.oai.workflows+yaml

The proposed MIME media type for Workflows that require a YAML-specific media type is defined as follows:

&emsp; Media type name: application

&emsp; Media subtype name: vnd.oai.workflows+yaml

&emsp; Required parameters: N/A

&emsp; Optional parameters: version (e.g. version=1.0.0 to indicate that the type of workflow conforms to version 1.0.0 of the Workflows Specification).

&emsp; Encoding considerations: Encoding considerations are identical to those specified for the `application/yaml` media type.

&emsp; Security considerations: See [security considerations](#security-considerations) above.

&emsp; Interoperability considerations: N/A

## <a name="revisionHistory"></a>Appendix A: Revision History

Expand Down
Loading