Skip to content
This repository was archived by the owner on May 2, 2022. It is now read-only.

Explicitly define auth protocol in protocol document#31

Merged
bleggett merged 3 commits intomasterfrom
clarify-pop-requirements
Feb 18, 2022
Merged

Explicitly define auth protocol in protocol document#31
bleggett merged 3 commits intomasterfrom
clarify-pop-requirements

Conversation

@bleggett
Copy link
Copy Markdown
Contributor

@bleggett bleggett commented Feb 17, 2022

Proposed Changes

Change type: PATCH

  • Pull the auth protocol bits out of the existing docs (ClaimsObject, etc), clarify them, and make them part of the top-level Protocol document.
  • Fix small inconsistency in example openAPI docs.

Checklist

  • A clear description of the change has been included in this PR.
  • A clear description of whether this change is a Major, Minor, Patch or cosmetic change as per the Versioning Guidelines has been included in this PR.
  • All schema validation tests have been updated appropriately and are passing.
  • This change otherwise adheres to the project Contribution Guidelines.

@bleggett bleggett changed the title Explicitly clarify auth protocol Explicitly define auth protocol in protocol document Feb 17, 2022
- type: object
required:
- clientPayloadSignature
- signedRequestToken
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be a PATCH this should deprecate the clientPayloadSignature, not replace it, otherwise this is arguably a major revision (clients with the same major revision should be backwards compatible)

You can say Deprecated, servers MAY allow this request when used, subject to configuration, instead of MUST

Copy link
Copy Markdown
Contributor Author

@bleggett bleggett Feb 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dmihalcik-virtru The OpenAPI spec is an example of An Implementation - not part of the spec. I should move it to examples. What an implementer calls this field in their schema is not defined in the spec, as that's an implementation detail.

The major spec version bump to 4 already introduced the general requirement for a payload signature, so this is not a new requirement. I'm just syncing the name of the field in the example OpenAPI spec we include.

Current openTDF implementations all use signedRequestToken already, and the example OpenAPI spec here had a mismatch on the name, so that's why it's just a patch.

@bleggett bleggett merged commit 76069df into master Feb 18, 2022
@bleggett bleggett deleted the clarify-pop-requirements branch February 18, 2022 17:19
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants