1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
|
# Release History
## 4.11.1 (Unreleased)
### Features Added
### Breaking Changes
### Bugs Fixed
### Other Changes
## 4.11.0 (2025-06-16)
### Features Added
- Added support for service API version `7.6`
- (From 4.11.0b1) `KeyClient` has a `get_key_attestation` method that can be used to retrieve a key along with its
attestation blob (stored in a new `KeyProperties.attestation` property) from a managed HSM
[#37507](https://github.com/Azure/azure-sdk-for-python/pull/37507)
### Bugs Fixed
- Fixed a bug where `KeyVaultRSAPublicKey` and `KeyVaultRSAPrivateKey` were not correctly implementing the `cryptography` library's `RSAPublicKey` and `RSAPrivateKey` interfaces, causing instantiation errors. ([#41205](https://github.com/Azure/azure-sdk-for-python/pull/41205))
### Breaking Changes
> These changes do not impact the API of stable versions such as 4.10.0. Only code written against a beta version such as 4.11.0b1 may be affected.
- The following enums have been moved:
- `EncryptionAlgorithm.ckm_aes_key_wrap` -> `KeyWrapAlgorithm.ckm_aes_key_wrap`
- `EncryptionAlgorithm.ckm_aes_key_wrap_pad` -> `KeyWrapAlgorithm.ckm_aes_key_wrap_pad`
### Other Changes
- Key Vault API version `7.6` is now the default
- (From 4.11.0b1) Updated minimum `typing-extensions` version to 4.6.0
## 4.11.0b1 (2025-03-20)
### Features Added
- Added support for service API version `7.6-preview.2`
- `KeyClient` has a `get_key_attestation` method that can be used to retrieve a key along with its attestation blob
(stored in a new `KeyProperties.attestation` property) from a managed HSM
[#37507](https://github.com/Azure/azure-sdk-for-python/pull/37507)
### Other Changes
- Updated minimum `typing-extensions` version to 4.6.0
## 4.10.0 (2024-10-17)
### Features Added
- Added support for Continuous Access Evaluation (CAE). `enable_cae=True` is passed to all `get_token` requests.
### Bugs Fixed
- Typing errors from using Key Vault clients as context managers have been fixed
([#34744](https://github.com/Azure/azure-sdk-for-python/issues/34744))
### Other Changes
- Updated minimum `azure-core` version to 1.31.0
## 4.9.0 (2024-02-22)
- Added support for service API version `7.5`
- (From 4.9.0b2) The `cryptography` library's `RSAPrivateKey` and `RSAPublicKey` interfaces are now implemented by
`KeyVaultRSAPrivateKey` and `KeyVaultRSAPublicKey` classes that can use keys managed by Key Vault
- (From 4.9.0b2) `CryptographyClient` has `create_rsa_private_key` and `create_rsa_public_key` methods that return a
`KeyVaultRSAPrivateKey` and `KeyVaultRSAPublicKey`, respectively
- (From 4.9.0b3) Added `KeyProperties.hsm_platform` to get the underlying HSM platform
### Bugs Fixed
- (From 4.9.0b1) Token requests made during AD FS authentication no longer specify an erroneous "adfs" tenant ID
([#29888](https://github.com/Azure/azure-sdk-for-python/issues/29888))
### Other Changes
- Python 3.7 is no longer supported. Please use Python version 3.8 or later.
- `asyncio` is no longer directly referenced by the library
([#33819](https://github.com/Azure/azure-sdk-for-python/pull/33819))
- Updated minimum `azure-core` version to 1.29.5
- Dropped `azure-common` requirement
## 4.9.0b3 (2023-11-03)
### Features Added
- Added support for service API version `7.5-preview.1`
- Added `KeyProperties.hsm_platform` to get the underlying HSM platform
### Other Changes
- Key Vault API version `7.5-preview.1` is now the default
## 4.9.0b2 (2023-10-12)
### Features Added
- The `cryptography` library's `RSAPrivateKey` and `RSAPublicKey` interfaces are now implemented by
`KeyVaultRSAPrivateKey` and `KeyVaultRSAPublicKey` classes that can use keys managed by Key Vault
- `CryptographyClient` has `create_rsa_private_key` and `create_rsa_public_key` methods that return a
`KeyVaultRSAPrivateKey` and `KeyVaultRSAPublicKey`, respectively
## 4.9.0b1 (2023-05-16)
### Bugs Fixed
- Token requests made during AD FS authentication no longer specify an erroneous "adfs" tenant ID
([#29888](https://github.com/Azure/azure-sdk-for-python/issues/29888))
## 4.8.0 (2023-03-16)
### Features Added
- Added support for service API version `7.4`
- Clients each have a `send_request` method that can be used to send custom requests using the
client's existing pipeline ([#25172](https://github.com/Azure/azure-sdk-for-python/issues/25172))
- (From 4.8.0b1) An attempt will be made to generate an IV if one isn't provided for local encryption
([#25380](https://github.com/Azure/azure-sdk-for-python/pull/25380))
### Breaking Changes
> These changes do not impact the API of stable versions such as 4.7.0. Only code written against a beta version such as 4.8.0b2 may be affected.
- Removed support for octet key pair (OKP) keys and operations
### Other Changes
- Key Vault API version `7.4` is now the default
- (From 4.8.0b1) Python 3.6 is no longer supported. Please use Python version 3.7 or later.
- (From 4.8.0b1) Updated minimum `azure-core` version to 1.24.0
- (From 4.8.0b1) Updated minimum `msrest` version to 0.7.1
- (From 4.8.0b2) Dropped `msrest` requirement
- (From 4.8.0b2) Dropped `six` requirement
- (From 4.8.0b2) Added requirement for `isodate>=0.6.1` (`isodate` was required by `msrest`)
- (From 4.8.0b2) Added requirement for `typing-extensions>=4.0.1`
## 4.8.0b2 (2022-11-15)
### Features Added
- Added support for service API version `7.4-preview.1`
- `KeyClient` has a `create_okp_key` method to create an octet key pair (OKP) on Managed HSM
- Added `eddsa` to `SignatureAlgorithm` enum to support signing and verifying using an
Edwards-Curve Digital Signature Algorithm (EdDSA) on Managed HSM
- Added `okp` and `okp_hsm` to `KeyType` enum for octet key pairs
- Added `ed25519` to `KeyCurveName` enum to support use of the Ed25519 Edwards curve
### Other Changes
- Key Vault API version `7.4-preview.1` is now the default
- Dropped `msrest` requirement
- Dropped `six` requirement
- Added requirement for `isodate>=0.6.1` (`isodate` was required by `msrest`)
- Added requirement for `typing-extensions>=4.0.1`
## 4.8.0b1 (2022-09-22)
### Features Added
- An attempt will be made to generate an IV if one isn't provided for local encryption
([#25380](https://github.com/Azure/azure-sdk-for-python/pull/25380))
### Other Changes
- Python 3.6 is no longer supported. Please use Python version 3.7 or later.
- Updated minimum `azure-core` version to 1.24.0
- Updated minimum `msrest` version to 0.7.1
## 4.7.0 (2022-09-19)
### Breaking Changes
- Clients verify the challenge resource matches the vault domain. This should affect few customers,
who can provide `verify_challenge_resource=False` to client constructors to disable.
See https://aka.ms/azsdk/blog/vault-uri for more information.
### Other Changes
- Changes from version 4.7.0b1 have been reverted and will be included in version 4.8.0b1
## 4.7.0b1 (2022-08-12)
### Features Added
- An attempt will be made to generate an IV if one isn't provided for local encryption
([#25380](https://github.com/Azure/azure-sdk-for-python/pull/25380))
### Other Changes
- The most recent release was version 4.6.1 instead of the intended version, 4.5.2.
The next stable release is planned to be version 4.7.0.
- Python 3.6 is no longer supported. Please use Python version 3.7 or later.
- Updated minimum `azure-core` version to 1.24.0
## 4.6.1 (2022-08-11)
### Other Changes
- Documentation improvements
([#25039](https://github.com/Azure/azure-sdk-for-python/issues/25039))
## 4.6.0b1 (2022-06-07)
### Bugs Fixed
- If a key's ID contains a port number, this port will now be preserved in the vault URL of a
`CryptographyClient` instance created from this key
([#24446](https://github.com/Azure/azure-sdk-for-python/issues/24446))
- Port numbers are now preserved in the `vault_url` property of a `KeyVaultKeyIdentifier`
## 4.5.1 (2022-04-18)
### Bugs Fixed
- Fixed error that could occur when fetching a key rotation policy that has no defined
`lifetime_actions`.
## 4.5.0 (2022-03-28)
### Features Added
- Key Vault API version 7.3 is now the default
- Added support for multi-tenant authentication when using `azure-identity`
1.8.0 or newer ([#20698](https://github.com/Azure/azure-sdk-for-python/issues/20698))
- (From 4.5.0b1) `KeyClient` has a `get_random_bytes` method for getting a requested number of
random bytes from a managed HSM
- (From 4.5.0b2) Added support for secure key release from a Managed HSM
([#19588](https://github.com/Azure/azure-sdk-for-python/issues/19588))
- Added `release_key` method to `KeyClient` for releasing the private component of a key
- Added `exportable` and `release_policy` keyword-only arguments to key creation and import
methods
- Added `KeyExportEncryptionAlgorithm` enum for specifying an encryption algorithm to be used
in key release
- (From 4.5.0b4) Added `KeyClient.get_cryptography_client`, which provides a simple way to
create a `CryptographyClient` for a key, given its name and optionally a version
([#20621](https://github.com/Azure/azure-sdk-for-python/issues/20621))
- (From 4.5.0b4) Added support for automated and on-demand key rotation in Azure Key Vault
([#19840](https://github.com/Azure/azure-sdk-for-python/issues/19840))
- Added `KeyClient.rotate_key` to rotate a key on-demand
- Added `KeyClient.update_key_rotation_policy` to update a key's automated rotation policy
- (From 4.5.0b6) Added `immutable` keyword-only argument and property to `KeyReleasePolicy` to
support immutable release policies. Once a release policy is marked as immutable, it can no
longer be modified.
### Breaking Changes
> These changes do not impact the API of stable versions such as 4.4.0.
> Only code written against a beta version such as 4.5.0b1 may be affected.
- `KeyClient.update_key_rotation_policy` accepts a required `policy` argument
([#22981](https://github.com/Azure/azure-sdk-for-python/issues/22981))
- The optional `version` parameter in `KeyClient.release_key` is now a keyword-only argument
([#22981](https://github.com/Azure/azure-sdk-for-python/issues/22981))
- Renamed the `name` parameter in `KeyClient.get_key_rotation_policy` and
`KeyClient.update_key_rotation_policy` to `key_name`
([#22981](https://github.com/Azure/azure-sdk-for-python/issues/22981))
- Enum values in `azure-keyvault-keys` are now uniformly lower-cased
([#22981](https://github.com/Azure/azure-sdk-for-python/issues/22981))
### Bugs Fixed
- `KeyType` now ignores casing during declaration, which resolves a scenario where Key Vault
keys created with non-standard casing could not be fetched with the SDK
([#22797](https://github.com/Azure/azure-sdk-for-python/issues/22797))
### Other Changes
- (From 4.5.0b6) Python 2.7 is no longer supported. Please use Python version 3.6 or later.
- (From 4.5.0b6) Updated minimum `azure-core` version to 1.20.0
- (From 4.5.0b3) Updated type hints to fix mypy errors
([#19158](https://github.com/Azure/azure-sdk-for-python/issues/19158))
- (From 4.5.0b4) `CryptographyClient` no longer requires a key version when providing a key ID to its constructor
(though providing a version is still recommended)
- (From 4.5.0b5) To support multi-tenant authentication, `get_token` calls during challenge
authentication requests now pass in a `tenant_id` keyword argument
([#20698](https://github.com/Azure/azure-sdk-for-python/issues/20698)). See
https://aka.ms/azsdk/python/identity/tokencredential for more details on how to integrate
this parameter if `get_token` is implemented by a custom credential.
- (From 4.5.0b6) Updated type hints for `KeyProperties` model's `managed`, `exportable`, and
`release_policy` properties ([#22368](https://github.com/Azure/azure-sdk-for-python/pull/22368))
## 4.5.0b6 (2022-02-08)
### Features Added
- Added `immutable` keyword-only argument and property to `KeyReleasePolicy` to support immutable
release policies. Once a release policy is marked as immutable, it can no longer be modified.
### Breaking Changes
> These changes do not impact the API of stable versions such as 4.4.0.
> Only code written against a beta version such as 4.5.0b1 may be affected.
- Renamed the required argument `data` in `KeyReleasePolicy`'s constructor to
`encoded_policy`
### Other Changes
- Python 2.7 is no longer supported. Please use Python version 3.6 or later.
- Updated minimum `azure-core` version to 1.20.0
- Updated type hints for `KeyProperties` model's `managed`, `exportable`, and `release_policy`
properties ([#22368](https://github.com/Azure/azure-sdk-for-python/pull/22368))
- (From 4.5.0b5) To support multi-tenant authentication, `get_token` calls during challenge
authentication requests now pass in a `tenant_id` keyword argument
([#20698](https://github.com/Azure/azure-sdk-for-python/issues/20698))
## 4.5.0b5 (2021-11-11)
### Features Added
- Added support for multi-tenant authentication when using `azure-identity` 1.7.1 or newer
([#20698](https://github.com/Azure/azure-sdk-for-python/issues/20698))
### Breaking Changes
> These changes do not impact the API of stable versions such as 4.4.0.
> Only code written against a beta version such as 4.5.0b1 may be affected.
- `KeyClient.get_random_bytes` now returns bytes instead of RandomBytes. The RandomBytes class
has been removed
- Renamed the `version` keyword-only argument in `KeyClient.get_cryptography_client` to
`key_version`
- Renamed `KeyReleasePolicy.data` to `KeyReleasePolicy.encoded_policy`
- Renamed the `target` parameter in `KeyClient.release_key` to `target_attestation_token`
### Other Changes
- Updated minimum `azure-core` version to 1.15.0
## 4.5.0b4 (2021-10-07)
### Features Added
- Added `KeyClient.get_cryptography_client`, which provides a simple way to create a
`CryptographyClient` for a key, given its name and optionally a version
([#20621](https://github.com/Azure/azure-sdk-for-python/issues/20621))
- Added support for automated and on-demand key rotation in Azure Key Vault
([#19840](https://github.com/Azure/azure-sdk-for-python/issues/19840))
- Added `KeyClient.rotate_key` to rotate a key on-demand
- Added `KeyClient.update_key_rotation_policy` to update a key's automated rotation policy
### Other Changes
- `CryptographyClient` no longer requires a key version when providing a key ID to its constructor
(though providing a version is still recommended)
## 4.5.0b3 (2021-09-09)
### Other Changes
- Updated type hints to fix mypy errors
([#19158](https://github.com/Azure/azure-sdk-for-python/issues/19158))
## 4.5.0b2 (2021-08-10)
### Features Added
- Added support for secure key release from a Managed HSM
([#19588](https://github.com/Azure/azure-sdk-for-python/issues/19588))
- Added `release_key` method to `KeyClient` for releasing the private component of a key
- Added `exportable` and `release_policy` keyword-only arguments to key creation and import
methods
- Added `KeyExportEncryptionAlgorithm` enum for specifying an encryption algorithm to be used
in key release
### Breaking Changes
> These changes do not impact the API of stable versions such as 4.4.0.
> Only code written against a beta version such as 4.5.0b1 may be affected.
- `KeyClient.get_random_bytes` now returns a `RandomBytes` model with bytes in a `value`
property, rather than returning the bytes directly
([#19895](https://github.com/Azure/azure-sdk-for-python/issues/19895))
## 4.5.0b1 (2021-07-08)
Beginning with this release, this library requires Python 2.7 or 3.6+.
### Features Added
- Key Vault API version 7.3-preview is now the default
- `KeyClient` has a `get_random_bytes` method for getting a requested number of random
bytes from a managed HSM
## 4.4.0 (2021-06-22)
This is the last version to support Python 3.5. The next version will require Python 2.7 or 3.6+.
### Changed
- Key Vault API version 7.2 is now the default
- (From 4.4.0b1) Updated minimum `msrest` version to 0.6.21
### Added
- `KeyClient` has a `create_oct_key` method for creating symmetric keys
- `KeyClient`'s `create_key` and `create_rsa_key` methods now accept a `public_exponent`
keyword-only argument ([#18016](https://github.com/Azure/azure-sdk-for-python/issues/18016))
- (From 4.4.0b1) Added support for Key Vault API version 7.2
([#16566](https://github.com/Azure/azure-sdk-for-python/pull/16566))
- Added `oct_hsm` to `KeyType`
- Added 128-, 192-, and 256-bit AES-GCM, AES-CBC, and AES-CBCPAD encryption
algorithms to `EncryptionAlgorithm`
- Added 128- and 192-bit AES-KW key wrapping algorithms to `KeyWrapAlgorithm`
- `CryptographyClient`'s `encrypt` method accepts `iv` and
`additional_authenticated_data` keyword arguments
- `CryptographyClient`'s `decrypt` method accepts `iv`,
`additional_authenticated_data`, and `authentication_tag` keyword arguments
- Added `iv`, `aad`, and `tag` properties to `EncryptResult`
- (From 4.4.0b3) `CryptographyClient` will perform all operations locally if initialized with
the `.from_jwk` factory method
([#16565](https://github.com/Azure/azure-sdk-for-python/pull/16565))
- (From 4.4.0b3) Added requirement for `six`>=1.12.0
- (From 4.4.0b4) `CryptographyClient` can perform AES-CBCPAD encryption and decryption locally
([#17762](https://github.com/Azure/azure-sdk-for-python/pull/17762))
### Breaking Changes
> These changes do not impact the API of stable versions such as 4.3.1.
> Only code written against a beta version such as 4.4.0b1 may be affected.
- `parse_key_vault_key_id` and `KeyVaultResourceId` have been replaced by a
`KeyVaultKeyIdentifier` class, which can be initialized with a key ID
## 4.4.0b4 (2021-04-06)
### Added
- `CryptographyClient` can perform AES-CBCPAD encryption and decryption locally
([#17762](https://github.com/Azure/azure-sdk-for-python/pull/17762))
## 4.4.0b3 (2021-03-11)
### Added
- `CryptographyClient` will perform all operations locally if initialized with
the `.from_jwk` factory method
([#16565](https://github.com/Azure/azure-sdk-for-python/pull/16565))
- Added requirement for six>=1.12.0
## 4.4.0b2 (2021-02-10)
### Fixed
- API versions older than 7.2-preview no longer raise `ImportError` when
performing async operations ([#16680](https://github.com/Azure/azure-sdk-for-python/pull/16680))
## 4.4.0b1 (2021-02-10)
### Changed
- Key Vault API version 7.2-preview is now the default
- Updated msrest requirement to >=0.6.21
### Added
- Support for Key Vault API version 7.2-preview
([#16566](https://github.com/Azure/azure-sdk-for-python/pull/16566))
- Added `oct_hsm` to `KeyType`
- Added 128-, 192-, and 256-bit AES-GCM, AES-CBC, and AES-CBCPAD encryption
algorithms to `EncryptionAlgorithm`
- Added 128- and 192-bit AES-KW key wrapping algorithms to `KeyWrapAlgorithm`
- `CryptographyClient`'s `encrypt` method accepts `iv` and
`additional_authenticated_data` keyword arguments
- `CryptographyClient`'s `decrypt` method accepts `iv`,
`additional_authenticated_data`, and `authentication_tag` keyword arguments
- Added `iv`, `aad`, and `tag` properties to `EncryptResult`
- Added method `parse_key_vault_key_id` that parses out a full ID returned by
Key Vault, so users can easily access the key's `name`, `vault_url`, and `version`.
## 4.3.1 (2020-12-03)
### Fixed
- `CryptographyClient` operations no longer raise `AttributeError` when
the client was constructed with a key ID
([#15608](https://github.com/Azure/azure-sdk-for-python/issues/15608))
## 4.3.0 (2020-10-06)
### Changed
- `CryptographyClient` can perform decrypt and sign operations locally
([#9754](https://github.com/Azure/azure-sdk-for-python/issues/9754))
### Fixed
- Correct typing for async paging methods
## 4.2.0 (2020-08-11)
### Fixed
- Values of `x-ms-keyvault-region` and `x-ms-keyvault-service-version` headers
are no longer redacted in logging output
- `CryptographyClient` will no longer perform encrypt or wrap operations when
its key has expired or is not yet valid
### Changed
- Key Vault API version 7.1 is now the default
- Updated minimum `azure-core` version to 1.7.0
### Added
- At construction, clients accept a `CustomHookPolicy` through the optional
keyword argument `custom_hook_policy`
- All client requests include a unique ID in the header `x-ms-client-request-id`
- Dependency on `azure-common` for multiapi support
## 4.2.0b1 (2020-03-10)
- Support for Key Vault API version 7.1-preview
([#10124](https://github.com/Azure/azure-sdk-for-python/pull/10124))
- Added `import_key` to `KeyOperation`
- Added `recoverable_days` to `CertificateProperties`
- Added `ApiVersion` enum identifying Key Vault versions supported by this package
## 4.1.0 (2020-03-10)
- `KeyClient` instances have a `close` method which closes opened sockets. Used
as a context manager, a `KeyClient` closes opened sockets on exit.
([#9906](https://github.com/Azure/azure-sdk-for-python/pull/9906))
- Pollers no longer sleep after operation completion
([#9991](https://github.com/Azure/azure-sdk-for-python/pull/9991))
## 4.0.1 (2020-02-11)
- `azure.keyvault.keys` defines `__version__`
- Challenge authentication policy preserves request options
([#8999](https://github.com/Azure/azure-sdk-for-python/pull/8999))
- Updated `msrest` requirement to >=0.6.0
- Challenge authentication policy requires TLS
([#9457](https://github.com/Azure/azure-sdk-for-python/pull/9457))
- Methods no longer raise the internal error `KeyVaultErrorException`
([#9690](https://github.com/Azure/azure-sdk-for-python/issues/9690))
- Fix `AttributeError` in async CryptographyClient when verifying signatures remotely
([#9734](https://github.com/Azure/azure-sdk-for-python/pull/9734))
## 4.0.0 (2019-10-31)
### Breaking changes:
- Removed `KeyClient.get_cryptography_client()` and `CryptographyClient.get_key()`
- Moved the optional parameters of several methods into kwargs (
[docs](https://azuresdkdocs.z19.web.core.windows.net/python/azure-keyvault-keys/latest/index.html)
detail the new keyword arguments):
- `create_key` now has positional parameters `name` and `key_type`
- `create_ec_key` and `create_rsa_key` now have one positional parameter, `name`
- `update_key_properties` now has two positional parameters, `name` and
(optional) `version`
- `import_key` now has positional parameters `name` and `key`
- `CryptographyClient` operations return class instances instead of tuples and renamed the following
properties
- Renamed the `decrypted_bytes` property of `DecryptResult` to `plaintext`
- Renamed the `unwrapped_bytes` property of `UnwrapResult` to `key`
- Renamed the `result` property of `VerifyResult` to `is_valid`
- Renamed the `UnwrapKeyResult` and `WrapKeyResult` classes to `UnwrapResult` and `WrapResult`
- Renamed `list_keys` to `list_properties_of_keys`
- Renamed `list_key_versions` to `list_properties_of_key_versions`
- Renamed sync method `delete_key` to `begin_delete_key`
- The sync method `begin_delete_key` and async `delete_key` now return pollers that return a `DeletedKey`
- Renamed `Key` to `KeyVaultKey`
- `KeyVaultKey` properties `created`, `expires`, and `updated` renamed to `created_on`,
`expires_on`, and `updated_on`
- The `vault_endpoint` parameter of `KeyClient` has been renamed to `vault_url`
- The property `vault_endpoint` has been renamed to `vault_url` in all models
### New features:
- Now all `CryptographyClient` returns include `key_id` and `algorithm` properties
## 4.0.0b4 (2019-10-08)
- Enums `JsonWebKeyCurveName`, `JsonWebKeyOperation`, and `JsonWebKeyType` have
been renamed to `KeyCurveName`, `KeyOperation`, and `KeyType`, respectively.
- `Key` now has attribute `properties`, which holds certain properties of the
key, such as `version`. This changes the shape of the returned `Key` type,
as certain properties of `Key` (such as `version`) have to be accessed
through the `properties` property.
- `update_key` has been renamed to `update_key_properties`
- The `vault_url` parameter of `KeyClient` has been renamed to `vault_endpoint`
- The property `vault_url` has been renamed to `vault_endpoint` in all models
### Fixes and improvements:
- The `key` argument to `import_key` should be an instance of `azure.keyvault.keys.JsonWebKey`
([#7590](https://github.com/Azure/azure-sdk-for-python/pull/7590))
## 4.0.0b3 (2019-09-11)
### Breaking changes:
- `CryptographyClient` methods `wrap` and `unwrap` are renamed `wrap_key` and
`unwrap_key`, respectively.
### New features:
- `CryptographyClient` performs encrypt, verify and wrap operations locally
when its key's public material is available (i.e., when it has keys/get
permission).
## 4.0.0b2 (2019-08-06)
### Breaking changes:
- Removed `azure.core.Configuration` from the public API in preparation for a
revamped configuration API. Static `create_config` methods have been renamed
`_create_config`, and will be removed in a future release.
- Removed `wrap_key` and `unwrap_key` from `KeyClient`. These are now available
through `CryptographyClient`.
- This version of the library requires `azure-core` 1.0.0b2
- If you later want to revert to a version requiring azure-core 1.0.0b1,
of this or another Azure SDK library, you must explicitly install azure-core
1.0.0b1 as well. For example:
`pip install azure-core==1.0.0b1 azure-keyvault-keys==4.0.0b1`
### New features:
- Added `CryptographyClient`, a client for performing cryptographic operations
(encrypt/decrypt, wrap/unwrap, sign/verify) with a key.
- Distributed tracing framework OpenCensus is now supported
- Added support for HTTP challenge based authentication, allowing clients to
interact with vaults in sovereign clouds.
### Other changes:
- Async clients use [aiohttp](https://pypi.org/project/aiohttp/) for transport
by default. See
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md/#transport)
for more information about using other transports.
## 4.0.0b1 (2019-06-28)
Version 4.0.0b1 is the first preview of our efforts to create a user-friendly
and Pythonic client library for Azure Key Vault. For more information about
preview releases of other Azure SDK libraries, please visit
https://aka.ms/azure-sdk-preview1-python.
This library is not a direct replacement for `azure-keyvault`. Applications
using that library would require code changes to use `azure-keyvault-keys`.
This package's
[documentation](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-keys/README.md)
and
[samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-keys/samples)
demonstrate the new API.
### Major changes from `azure-keyvault`
- Packages scoped by functionality
- `azure-keyvault-keys` contains a client for key operations,
`azure-keyvault-secrets` contains a client for secret operations
- Client instances are scoped to vaults (an instance interacts with one vault
only)
- Asynchronous API supported on Python 3.5.3+
- the `azure.keyvault.keys.aio` namespace contains an async equivalent of
the synchronous client in `azure.keyvault.keys`
- Authentication using `azure-identity` credentials
- see this package's
[documentation](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-keys/README.md)
, and the
[Azure Identity documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/README.md)
for more information
### `azure-keyvault` features not implemented in this release
- Certificate management APIs
- Cryptographic operations, e.g. sign, un/wrap_key, verify, en- and
decrypt
- National cloud support. This release supports public global cloud vaults,
e.g. https://{vault-name}.vault.azure.net
|