Skip to content

Key Vault keys API: Add OKP key type and EdDSA digital signature #15989

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

Merged
lmazuel merged 3 commits into from
Nov 12, 2021
Merged

Key Vault keys API: Add OKP key type and EdDSA digital signature #15989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3146c71
Add OKP key type and EdDSA digital signature
docschmidt Sep 9, 2021
89f73fa
Address feedback
docschmidt Sep 10, 2021
01707c4
Fix validation error
docschmidt Oct 25, 2021
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
47 changes: 37 additions & 10 deletions specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,7 +1323,9 @@
"RSA",
"RSA-HSM",
"oct",
"oct-HSM"
"oct-HSM",
"OKP",
"OKP-HSM"
],
"x-ms-enum": {
"name": "JsonWebKeyType",
Expand Down Expand Up @@ -1352,6 +1354,14 @@
{
"value": "oct-HSM",
"description": "Octet sequence (used to represent symmetric keys) which is stored the HSM."
},
{
"value": "OKP",
"description": "Octet key pair (https://tools.ietf.org/html/rfc8037)"
},
{
"value": "OKP-HSM",
"description": "Octet key pair (https://tools.ietf.org/html/rfc8037) with a private key which is stored in the HSM."
Comment thread
docschmidt marked this conversation as resolved.
}
]
}
Expand All @@ -1376,7 +1386,7 @@
"d": {
"type": "string",
"format": "base64url",
"description": "RSA private exponent, or the D component of an EC private key."
"description": "RSA private exponent, or the D component of an EC or OKP private key."
},
"dp": {
"x-ms-client-name": "DP",
Expand Down Expand Up @@ -1424,7 +1434,8 @@
"P-256",
"P-384",
"P-521",
"P-256K"
"P-256K",
"Ed25519"
],
"x-ms-enum": {
"name": "JsonWebKeyCurveName",
Expand All @@ -1445,14 +1456,18 @@
{
"value": "P-256K",
"description": "The SECG SECP256K1 elliptic curve."
},
{
"value": "Ed25519",
"description": "The Ed25519 Edwards curve."
}
]
}
},
"x": {
"type": "string",
"format": "base64url",
"description": "X component of an EC public key."
"description": "X component of an EC or OKP public key."
},
"y": {
"type": "string",
Expand Down Expand Up @@ -1654,7 +1669,9 @@
"RSA",
"RSA-HSM",
"oct",
"oct-HSM"
"oct-HSM",
"OKP",
"OKP-HSM"
],
"x-ms-enum": {
"name": "JsonWebKeyType",
Expand All @@ -1678,7 +1695,8 @@
"P-256",
"P-384",
"P-521",
"P-256K"
"P-256K",
"Ed25519"
],
"x-ms-enum": {
"name": "JsonWebKeyCurveName",
Expand All @@ -1700,7 +1718,9 @@
"RSA",
"RSA-HSM",
"oct",
"oct-HSM"
"oct-HSM",
"OKP",
"OKP-HSM"
],
"x-ms-enum": {
"name": "JsonWebKeyType",
Copy link
Copy Markdown
Member

@TimLovellSmith TimLovellSmith Oct 19, 2021

Choose a reason for hiding this comment

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

You have two definitions of 'JsonWebKeyType', identical as far as I can see. And similarly two definitiosn of 'JsonWebKeyCurveName'. You might like to consider refactoring them to be $refs to a single 'definition'.

Copy link
Copy Markdown
Contributor Author

@docschmidt docschmidt Oct 19, 2021

Choose a reason for hiding this comment

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

It was my understanding that OpenAPI 2.0 does not support reusable enums. Please let me know if I'm mistaken.

Expand Down Expand Up @@ -1757,7 +1777,8 @@
"P-256",
"P-384",
"P-521",
"P-256K"
"P-256K",
"Ed25519"
],
"x-ms-enum": {
"name": "JsonWebKeyCurveName",
Expand Down Expand Up @@ -1939,7 +1960,8 @@
"ES256",
"ES384",
"ES512",
"ES256K"
"ES256K",
"EdDSA"
],
"x-ms-enum": {
"name": "JsonWebKeySignatureAlgorithm",
Expand Down Expand Up @@ -1988,6 +2010,10 @@
{
"value": "ES256K",
"description": "ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518"
},
{
"value": "EdDSA",
"description": "Edwards-Curve Digital Signature Algorithm, as described in https://tools.ietf.org/html/rfc8032."
}
]
}
Expand Down Expand Up @@ -2021,7 +2047,8 @@
"ES256",
"ES384",
"ES512",
"ES256K"
"ES256K",
"EdDSA"
],
"x-ms-enum": {
"name": "JsonWebKeySignatureAlgorithm",
Expand Down
1 change: 0 additions & 1 deletion specification/keyvault/data-plane/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@ This is not used by Autorest itself.
``` yaml $(swagger-to-sdk)
swagger-to-sdk:
- repo: azure-sdk-for-go
- repo: azure-sdk-for-net-track2
```

## C#
Expand Down