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.

Sign up for GitHub

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

Jump to bottom

Add IV, tag, AAD to KeyOperationResult #11228

Merged
merged 3 commits into from
Dec 17, 2020
Merged

Add IV, tag, AAD to KeyOperationResult #11228

merged 3 commits into from
Dec 17, 2020

Conversation

daviddesberg
Copy link
Contributor

Adds IV, tag, and additional authenticated data to KeyOperationResult. These are necessary for the results of certain symmetric key algorithms and may be necessary for the results of wrap operations in the future.

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service

  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @lusitanian Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 15, 2020 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    azure-sdk-for-go

    ️✔️ succeeded [Logs] [Expand Details]

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    Azure CLI Extension Generation

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    azure-sdk-for-python

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    azure-sdk-for-js

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    azure-sdk-for-java

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    azure-sdk-for-python-track2

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    azure-sdk-for-net

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    azure-resource-manager-schemas

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 15, 2020 •
    edited
    Loading

    Trenton Generation

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    heaths
    heaths requested changes Oct 15, 2020
    View reviewed changes
    Copy link
    Member

    @heaths heaths left a comment

    Choose a reason for hiding this comment

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

    You'll probably need to regenerate (or hand-tweak, but it's always good to validate the service does what you expect) the example(s).

    specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json Outdated Show resolved Hide resolved
    specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json Outdated Show resolved Hide resolved
    specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json Outdated Show resolved Hide resolved
    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @tjprescott
    Copy link
    Member

    @lusitanian please review the LintDiff failure.

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @daviddesberg
    Copy link
    Contributor Author

    @heaths @tjprescott this has been sitting here for a while and as I understand from Heath it was important that we get this change in ASAP. The CI usually fails so it's not clear if there's anything in particular I should be looking for?

    @heaths
    Copy link
    Member

    heaths commented Oct 29, 2020

    @tjprescott the lint errors I looked at specific have always been there and Key Vault has no plans to fix them at this time. If there's a way to suppress them for now, please advise; otherwise, please merge this.

    @tjprescott
    Copy link
    Member

    @lmazuel can you merge this? I don't have permissions to merge with the failing LintDiff check.

    @tjprescott
    Copy link
    Member

    /azp run

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 17, 2020 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c05f4de. SDK Automation 14.0.0 
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/keyvault/v7.2-preview/keyvault [View full logs]  [Release SDK Changes]
      Only show 24 items here, please refer to log for details.
      info	[Changelog] 1. RoleDefinitionsClient.CreateOrUpdateResponder(*http.Response) (RoleDefinition, error)
info	[Changelog] 1. RoleDefinitionsClient.CreateOrUpdateSender(*http.Request) (*http.Response, error)
info	[Changelog] 1. RoleDefinitionsClient.Delete(context.Context, string, string, string) (RoleDefinition, error)
info	[Changelog] 1. RoleDefinitionsClient.DeletePreparer(context.Context, string, string, string) (*http.Request, error)
info	[Changelog] 1. RoleDefinitionsClient.DeleteResponder(*http.Response) (RoleDefinition, error)
info	[Changelog] 1. RoleDefinitionsClient.DeleteSender(*http.Request) (*http.Response, error)
info	[Changelog] 1. RoleDefinitionsClient.Get(context.Context, string, string, string) (RoleDefinition, error)
info	[Changelog] 1. RoleDefinitionsClient.GetPreparer(context.Context, string, string, string) (*http.Request, error)
info	[Changelog] 1. RoleDefinitionsClient.GetResponder(*http.Response) (RoleDefinition, error)
info	[Changelog] 1. RoleDefinitionsClient.GetSender(*http.Request) (*http.Response, error)
info	[Changelog]
info	[Changelog] ## Struct Changes
info	[Changelog]
info	[Changelog] ### New Structs
info	[Changelog]
info	[Changelog] 1. RoleDefinitionCreateParameters
info	[Changelog]
info	[Changelog] ### New Struct Fields
info	[Changelog]
info	[Changelog] 1. KeyOperationResult.AdditionalAuthenticatedData
info	[Changelog] 1. KeyOperationResult.AuthenticationTag
info	[Changelog] 1. KeyOperationResult.Iv
info	[Changelog] 1. RoleDefinition.autorest.Response
info	[Changelog]
    • ️✔️keyvault/v7.1/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️keyvault/v7.0/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️keyvault/2016-10-01/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️keyvault/2015-06-01/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    Posted by Swagger Pipeline | How to fix these errors?

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @tjprescott tjprescott merged commit c05f4de into Azure:master Dec 17, 2020
    This was referenced Dec 17, 2020
    Closed
    Closed
    Closed
    Closed
    Closed
    giromm2ms pushed a commit to giromm2ms/azure-rest-api-specs that referenced this pull request Dec 20, 2020
    @daviddesberg
    Add IV, tag, AAD to KeyOperationResult (Azure#11228)
    3851c41 
    * Add IV, tag, AAD to KeyOperationResult

* fix x-ms-client-name properties

* fix lintdiff
    josuhazure pushed a commit to josuhazure/azure-rest-api-specs that referenced this pull request Jan 6, 2021
    @daviddesberg
    Add IV, tag, AAD to KeyOperationResult (Azure#11228)
    02e5a61 
    * Add IV, tag, AAD to KeyOperationResult

* fix x-ms-client-name properties

* fix lintdiff
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @heaths heaths heaths approved these changes

    @tjprescott tjprescott tjprescott approved these changes

    @jlichwa jlichwa Awaiting requested review from jlichwa jlichwa is a code owner

    @RandalliLama RandalliLama Awaiting requested review from RandalliLama

    Assignees

    @tjprescott tjprescott

    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @daviddesberg @tjprescott @heaths