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 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
// Copyright 2020 Contributors to the Parsec project. // SPDX-License-Identifier: Apache-2.0 //! Basic client for Parsec integration use super::operation_client::OperationClient; use crate::auth::AuthenticationData; use crate::error::{ClientErrorKind, Error, Result}; use parsec_interface::operations::list_authenticators::{ AuthenticatorInfo, Operation as ListAuthenticators, }; use parsec_interface::operations::list_opcodes::Operation as ListOpcodes; use parsec_interface::operations::list_providers::{Operation as ListProviders, ProviderInfo}; use parsec_interface::operations::ping::Operation as Ping; use parsec_interface::operations::psa_aead_decrypt::Operation as PsaAeadDecrypt; use parsec_interface::operations::psa_aead_encrypt::Operation as PsaAeadEncrypt; use parsec_interface::operations::psa_algorithm::{ Aead, AsymmetricEncryption, AsymmetricSignature, Hash, RawKeyAgreement, }; use parsec_interface::operations::psa_asymmetric_decrypt::Operation as PsaAsymDecrypt; use parsec_interface::operations::psa_asymmetric_encrypt::Operation as PsaAsymEncrypt; use parsec_interface::operations::psa_destroy_key::Operation as PsaDestroyKey; use parsec_interface::operations::psa_export_key::Operation as PsaExportKey; use parsec_interface::operations::psa_export_public_key::Operation as PsaExportPublicKey; use parsec_interface::operations::psa_generate_key::Operation as PsaGenerateKey; use parsec_interface::operations::psa_generate_random::Operation as PsaGenerateRandom; use parsec_interface::operations::psa_hash_compare::Operation as PsaHashCompare; use parsec_interface::operations::psa_hash_compute::Operation as PsaHashCompute; use parsec_interface::operations::psa_import_key::Operation as PsaImportKey; use parsec_interface::operations::psa_key_attributes::Attributes; use parsec_interface::operations::psa_raw_key_agreement::Operation as PsaRawKeyAgreement; use parsec_interface::operations::psa_sign_hash::Operation as PsaSignHash; use parsec_interface::operations::psa_verify_hash::Operation as PsaVerifyHash; use parsec_interface::operations::{NativeOperation, NativeResult}; use parsec_interface::requests::{Opcode, ProviderID}; use parsec_interface::secrecy::{ExposeSecret, Secret}; use std::collections::HashSet; use zeroize::Zeroizing; /// Core client for Parsec service /// /// The client exposes low-level functionality for using the Parsec service. /// Below you can see code examples for a few of the operations supported. /// /// For all cryptographic operations an implicit provider is used which can be /// changed between operations. The client starts with no such defined provider /// and it is the responsibility of the user to identify and set an appropriate /// one. As such, it is critical that before attempting to use cryptographic /// operations users call [`list_providers`](#method.list_providers) /// and [`list_opcodes`](#method.list_opcodes) /// in order to figure out if their desired use case and provider are /// available. /// /// Creating a `BasicClient` instance: ///```no_run ///use parsec_client::auth::AuthenticationData; ///use parsec_client::BasicClient; ///use parsec_client::core::secrecy::Secret; /// ///let app_name = String::from("app-name"); ///let app_auth_data = AuthenticationData::AppIdentity(Secret::new(app_name)); ///let client: BasicClient = BasicClient::new(app_auth_data); ///``` /// /// Performing a Ping operation helps to determine if the service is available /// and what wire protocol it supports. Currently only a version 1.0 of the wire /// protocol exists and new versions are expected to be extremely rare. ///```no_run ///# use parsec_client::auth::AuthenticationData; ///# use parsec_client::BasicClient; ///# use parsec_client::core::secrecy::Secret; ///# use parsec_client::core::interface::requests::ProviderID; ///# let client: BasicClient = BasicClient::new(AuthenticationData::AppIdentity(Secret::new(String::from("app-name")))); ///let res = client.ping(); /// ///if let Ok((wire_prot_v_maj, wire_prot_v_min)) = res { /// println!( /// "Success! Service wire protocol version is {}.{}", /// wire_prot_v_maj, wire_prot_v_min /// ); ///} else { /// panic!("Ping failed. Error: {:?}", res); ///} ///``` /// /// Providers are abstracted representations of the secure elements that /// PARSEC offers abstraction over. Providers are the ones to execute the /// cryptographic operations requested by the user. /// /// Checking for available providers: ///```no_run ///# use parsec_client::auth::AuthenticationData; ///# use parsec_client::BasicClient; ///# use parsec_client::core::secrecy::Secret; ///# use parsec_client::core::interface::requests::ProviderID; ///# let client: BasicClient = BasicClient::new(AuthenticationData::AppIdentity(Secret::new(String::from("app-name")))); ///use uuid::Uuid; /// ///// Identify provider by its UUID (in this case, the PKCS11 provider) ///let desired_provider_uuid = Uuid::parse_str("30e39502-eba6-4d60-a4af-c518b7f5e38f").unwrap(); ///let available_providers = client.list_providers().expect("Failed to list providers"); ///if available_providers /// .iter() /// .filter(|provider| provider.uuid == desired_provider_uuid) /// .count() /// == 0 ///{ /// panic!("Did not find desired provider!"); ///} ///``` /// /// Checking operations supported by the provider we're interested in is done /// through the `list_opcodes` method: ///```no_run ///# use parsec_client::auth::AuthenticationData; ///# use parsec_client::BasicClient; ///# use parsec_client::core::interface::requests::ProviderID; ///# use parsec_client::core::secrecy::Secret; ///# let mut client: BasicClient = BasicClient::new(AuthenticationData::AppIdentity(Secret::new(String::from("app-name")))); ///use parsec_client::core::interface::requests::Opcode; /// ///let desired_provider = ProviderID::Pkcs11; ///let provider_opcodes = client /// .list_opcodes(desired_provider) /// .expect("Failed to list opcodes"); ///// Each operation is identified by a specific `Opcode` ///assert!(provider_opcodes.contains(&Opcode::PsaGenerateKey)); ///assert!(provider_opcodes.contains(&Opcode::PsaSignHash)); ///assert!(provider_opcodes.contains(&Opcode::PsaDestroyKey)); /// ///// Now that we're certain our desired provider offers all the functionality we need... ///client.set_implicit_provider(desired_provider); ///``` /// /// Creating a key-pair for signing SHA256 digests with RSA PKCS#1 v1.5: ///```no_run ///# use parsec_client::auth::AuthenticationData; ///# use parsec_client::BasicClient; ///# use parsec_client::core::secrecy::Secret; ///# use parsec_client::core::interface::requests::ProviderID; ///# let client: BasicClient = BasicClient::new(AuthenticationData::AppIdentity(Secret::new(String::from("app-name")))); ///use parsec_client::core::interface::operations::psa_algorithm::{Algorithm, AsymmetricSignature, Hash}; ///use parsec_client::core::interface::operations::psa_key_attributes::{Attributes, Lifetime, Policy, Type, UsageFlags}; /// ///let key_name = String::from("rusty key 🔑"); ///// This algorithm identifier will be used within the key policy (i.e. what ///// algorithms are usable with the key) and for indicating the desired ///// algorithm for each operation involving the key. ///let asym_sign_algo = AsymmetricSignature::RsaPkcs1v15Sign { /// hash_alg: Hash::Sha256.into(), ///}; /// ///// The key attributes define and limit the usage of the key material stored ///// by the underlying cryptographic provider. ///let key_attrs = Attributes { /// lifetime: Lifetime::Persistent, /// key_type: Type::RsaKeyPair, /// bits: 2048, /// policy: Policy { /// usage_flags: UsageFlags { /// export: true, /// copy: true, /// cache: true, /// encrypt: false, /// decrypt: false, /// sign_message: true, /// verify_message: false, /// sign_hash: true, /// verify_hash: false, /// derive: false, /// }, /// permitted_algorithms: asym_sign_algo.into(), /// }, ///}; /// ///client /// .psa_generate_key(key_name.clone(), key_attrs) /// .expect("Failed to create key!"); ///``` #[derive(Debug)] pub struct BasicClient { pub(crate) op_client: OperationClient, pub(crate) auth_data: AuthenticationData, pub(crate) implicit_provider: Option<ProviderID>, } /// Main client functionality. impl BasicClient { /// Create a new Parsec client given the authentication data of the app. /// /// Before you can use this client for cryptographic operations, you first need to call /// [`set_implicit_provider`](#method.set_implicit_provider). In order to get a list of /// supported providers, call the [`list_providers`](#method.list_providers) method. pub fn new(auth_data: AuthenticationData) -> Self { BasicClient { op_client: Default::default(), auth_data, implicit_provider: None, } } /// Update the authentication data of the client. pub fn set_auth_data(&mut self, auth_data: AuthenticationData) { self.auth_data = auth_data; } /// Retrieve authentication data of the client. pub fn auth_data(&self) -> AuthenticationData { self.auth_data.clone() } /// Set the provider that the client will be implicitly working with. pub fn set_implicit_provider(&mut self, provider: ProviderID) { self.implicit_provider = Some(provider); } /// Retrieve client's implicit provider. pub fn implicit_provider(&self) -> Option<ProviderID> { self.implicit_provider } /// **[Core Operation]** List the opcodes supported by the specified provider. pub fn list_opcodes(&self, provider: ProviderID) -> Result<HashSet<Opcode>> { let res = self.op_client.process_operation( NativeOperation::ListOpcodes(ListOpcodes { provider_id: provider, }), ProviderID::Core, &self.auth_data, )?; if let NativeResult::ListOpcodes(res) = res { Ok(res.opcodes) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Core Operation]** List the providers that are supported by the service. pub fn list_providers(&self) -> Result<Vec<ProviderInfo>> { let res = self.op_client.process_operation( NativeOperation::ListProviders(ListProviders {}), ProviderID::Core, &self.auth_data, )?; if let NativeResult::ListProviders(res) = res { Ok(res.providers) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Core Operation]** List the authenticators that are supported by the service. pub fn list_authenticators(&self) -> Result<Vec<AuthenticatorInfo>> { let res = self.op_client.process_operation( NativeOperation::ListAuthenticators(ListAuthenticators {}), ProviderID::Core, &self.auth_data, )?; if let NativeResult::ListAuthenticators(res) = res { Ok(res.authenticators) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Core Operation]** Send a ping request to the service. /// /// This operation is intended for testing connectivity to the /// service and for retrieving the maximum wire protocol version /// it supports. pub fn ping(&self) -> Result<(u8, u8)> { let res = self.op_client.process_operation( NativeOperation::Ping(Ping {}), ProviderID::Core, &AuthenticationData::None, )?; if let NativeResult::Ping(res) = res { Ok((res.wire_protocol_version_maj, res.wire_protocol_version_min)) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Generate a key. /// /// Creates a new key with the given name within the namespace of the /// implicit client provider. Any UTF-8 string is considered a valid key name, /// however names must be unique per provider. /// /// Persistence of keys is implemented at provider level, and currently all /// providers persist all the keys users create. However, no methods exist /// for discovering previously generated or imported keys, so users are /// responsible for keeping track of keys they have created. /// /// # Errors /// /// If this method returns an error, no key will have been generated and /// the name used will still be available for another key. /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_generate_key.html#specific-response-status-codes). pub fn psa_generate_key(&self, key_name: String, key_attributes: Attributes) -> Result<()> { let crypto_provider = self.can_provide_crypto()?; let op = PsaGenerateKey { key_name, attributes: key_attributes, }; let _ = self.op_client.process_operation( NativeOperation::PsaGenerateKey(op), crypto_provider, &self.auth_data, )?; Ok(()) } /// **[Cryptographic Operation]** Destroy a key. /// /// Given that keys are namespaced at a provider level, it is /// important to call `psa_destroy_key` on the correct combination of /// implicit client provider and `key_name`. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_destroy_key.html#specific-response-status-codes). pub fn psa_destroy_key(&self, key_name: String) -> Result<()> { let crypto_provider = self.can_provide_crypto()?; let op = PsaDestroyKey { key_name }; let _ = self.op_client.process_operation( NativeOperation::PsaDestroyKey(op), crypto_provider, &self.auth_data, )?; Ok(()) } /// **[Cryptographic Operation]** Import a key. /// /// Creates a new key with the given name within the namespace of the /// implicit client provider using the user-provided data. Any UTF-8 string is /// considered a valid key name, however names must be unique per provider. /// /// The key material should follow the appropriate binary format expressed /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_export_public_key.html). /// Several crates (e.g. [`picky-asn1`](https://crates.io/crates/picky-asn1)) /// can greatly help in dealing with binary encodings. /// /// Persistence of keys is implemented at provider level, and currently all /// providers persist all the keys users create. However, no methods exist /// for discovering previously generated or imported keys, so users are /// responsible for keeping track of keys they have created. /// /// # Errors /// /// If this method returns an error, no key will have been imported and the /// name used will still be available for another key. /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_import_key.html#specific-response-status-codes). pub fn psa_import_key( &self, key_name: String, key_material: &[u8], key_attributes: Attributes, ) -> Result<()> { let key_material = Secret::new(key_material.to_vec()); let crypto_provider = self.can_provide_crypto()?; let op = PsaImportKey { key_name, attributes: key_attributes, data: key_material, }; let _ = self.op_client.process_operation( NativeOperation::PsaImportKey(op), crypto_provider, &self.auth_data, )?; Ok(()) } /// **[Cryptographic Operation]** Export a public key or the public part of a key pair. /// /// The returned key material will follow the appropriate binary format expressed /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_export_public_key.html). /// Several crates (e.g. [`picky-asn1`](https://crates.io/crates/picky-asn1)) /// can greatly help in dealing with binary encodings. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_export_public_key.html#specific-response-status-codes). pub fn psa_export_public_key(&self, key_name: String) -> Result<Vec<u8>> { let crypto_provider = self.can_provide_crypto()?; let op = PsaExportPublicKey { key_name }; let res = self.op_client.process_operation( NativeOperation::PsaExportPublicKey(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaExportPublicKey(res) = res { Ok(res.data.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Export a key. /// /// The returned key material will follow the appropriate binary format expressed /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_export_key.html). /// Several crates (e.g. [`picky-asn1`](https://crates.io/crates/picky-asn1)) /// can greatly help in dealing with binary encodings. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_export_key.html#specific-response-status-codes). pub fn psa_export_key(&self, key_name: String) -> Result<Vec<u8>> { let crypto_provider = self.can_provide_crypto()?; let op = PsaExportKey { key_name }; let res = self.op_client.process_operation( NativeOperation::PsaExportKey(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaExportKey(res) = res { Ok(res.data.expose_secret().to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Create an asymmetric signature on a pre-computed message digest. /// /// The key intended for signing **must** have its `sign_hash` flag set /// to `true` in its [key policy](https://docs.rs/parsec-interface/*/parsec_interface/operations/psa_key_attributes/struct.Policy.html). /// /// The signature will be created with the algorithm defined in /// `sign_algorithm`, but only after checking that the key policy /// and type conform with it. /// /// `hash` must be a hash pre-computed over the message of interest /// with the algorithm specified within `sign_algorithm`. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_sign_hash.html#specific-response-status-codes). pub fn psa_sign_hash( &self, key_name: String, hash: &[u8], sign_algorithm: AsymmetricSignature, ) -> Result<Vec<u8>> { let hash = Zeroizing::new(hash.to_vec()); let crypto_provider = self.can_provide_crypto()?; let op = PsaSignHash { key_name, alg: sign_algorithm, hash, }; let res = self.op_client.process_operation( NativeOperation::PsaSignHash(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaSignHash(res) = res { Ok(res.signature.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Verify an existing asymmetric signature over a pre-computed message digest. /// /// The key intended for signing **must** have its `verify_hash` flag set /// to `true` in its [key policy](https://docs.rs/parsec-interface/*/parsec_interface/operations/psa_key_attributes/struct.Policy.html). /// /// The signature will be verifyied with the algorithm defined in /// `sign_algorithm`, but only after checking that the key policy /// and type conform with it. /// /// `hash` must be a hash pre-computed over the message of interest /// with the algorithm specified within `sign_algorithm`. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_verify_hash.html#specific-response-status-codes). pub fn psa_verify_hash( &self, key_name: String, hash: &[u8], sign_algorithm: AsymmetricSignature, signature: &[u8], ) -> Result<()> { let hash = Zeroizing::new(hash.to_vec()); let signature = Zeroizing::new(signature.to_vec()); let crypto_provider = self.can_provide_crypto()?; let op = PsaVerifyHash { key_name, alg: sign_algorithm, hash, signature, }; let _ = self.op_client.process_operation( NativeOperation::PsaVerifyHash(op), crypto_provider, &self.auth_data, )?; Ok(()) } /// **[Cryptographic Operation]** Encrypt a short message. /// /// The key intended for encrypting **must** have its `encrypt` flag set /// to `true` in its [key policy](https://docs.rs/parsec-interface/*/parsec_interface/operations/psa_key_attributes/struct.Policy.html). /// /// The encryption will be performed with the algorithm defined in `alg`, /// but only after checking that the key policy and type conform with it. /// /// `salt` can be provided if supported by the algorithm. If the algorithm does not support salt, pass // an empty vector. If the algorithm supports optional salt, pass an empty vector to indicate no // salt. For RSA PKCS#1 v1.5 encryption, no salt is supported. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_asymmetric_encrypt.html#specific-response-status-codes). pub fn psa_asymmetric_encrypt( &self, key_name: String, encrypt_alg: AsymmetricEncryption, plaintext: &[u8], salt: Option<&[u8]>, ) -> Result<Vec<u8>> { let salt = salt.map(|salt_ref| salt_ref.to_vec().into()); let crypto_provider = self.can_provide_crypto()?; let op = PsaAsymEncrypt { key_name, alg: encrypt_alg, plaintext: plaintext.to_vec().into(), salt, }; let encrypt_res = self.op_client.process_operation( NativeOperation::PsaAsymmetricEncrypt(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaAsymmetricEncrypt(res) = encrypt_res { Ok(res.ciphertext.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Decrypt a short message. /// /// The key intended for decrypting **must** have its `decrypt` flag set /// to `true` in its [key policy](https://docs.rs/parsec-interface/*/parsec_interface/operations/psa_key_attributes/struct.Policy.html). /// /// `salt` can be provided if supported by the algorithm. If the algorithm does not support salt, pass // an empty vector. If the algorithm supports optional salt, pass an empty vector to indicate no // salt. For RSA PKCS#1 v1.5 encryption, no salt is supported. /// /// /// The decryption will be performed with the algorithm defined in `alg`, /// but only after checking that the key policy and type conform with it. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_asymmetric_decrypt.html#specific-response-status-codes). pub fn psa_asymmetric_decrypt( &self, key_name: String, encrypt_alg: AsymmetricEncryption, ciphertext: &[u8], salt: Option<&[u8]>, ) -> Result<Vec<u8>> { let salt = match salt { Some(salt) => Some(Zeroizing::new(salt.to_vec())), None => None, }; let crypto_provider = self.can_provide_crypto()?; let op = PsaAsymDecrypt { key_name, alg: encrypt_alg, ciphertext: Zeroizing::new(ciphertext.to_vec()), salt, }; let decrypt_res = self.op_client.process_operation( NativeOperation::PsaAsymmetricDecrypt(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaAsymmetricDecrypt(res) = decrypt_res { Ok(res.plaintext.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Compute hash of a message. /// /// The hash computation will be performed with the algorithm defined in `alg`. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_hash_compute.html#specific-response-status-codes). pub fn psa_hash_compute(&self, alg: Hash, input: &[u8]) -> Result<Vec<u8>> { let crypto_provider = self.can_provide_crypto()?; let op = PsaHashCompute { alg, input: input.to_vec().into(), }; let hash_compute_res = self.op_client.process_operation( NativeOperation::PsaHashCompute(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaHashCompute(res) = hash_compute_res { Ok(res.hash.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Compute hash of a message and compare it with a reference value. /// /// The hash computation will be performed with the algorithm defined in `alg`. /// /// If this operation returns no error, the hash was computed successfully and it matches the reference value. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_hash_compare.html#specific-response-status-codes). pub fn psa_hash_compare(&self, alg: Hash, input: &[u8], hash: &[u8]) -> Result<()> { let crypto_provider = self.can_provide_crypto()?; let op = PsaHashCompare { alg, input: input.to_vec().into(), hash: hash.to_vec().into(), }; let _ = self.op_client.process_operation( NativeOperation::PsaHashCompare(op), crypto_provider, &self.auth_data, )?; Ok(()) } /// **[Cryptographic Operation]** Authenticate and encrypt a short message. /// /// The key intended for decrypting **must** have its `encrypt` flag set /// to `true` in its [key policy](https://docs.rs/parsec-interface/*/parsec_interface/operations/psa_key_attributes/struct.Policy.html). /// /// The encryption will be performed with the algorithm defined in `alg`, /// but only after checking that the key policy and type conform with it. /// /// `nonce` must be appropriate for the selected `alg`. /// /// For algorithms where the encrypted data and the authentication tag are defined as separate outputs, /// the returned buffer will contain the encrypted data followed by the authentication data. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_aead_encrypt.html#specific-response-status-codes). pub fn psa_aead_encrypt( &self, key_name: String, encrypt_alg: Aead, nonce: &[u8], additional_data: &[u8], plaintext: &[u8], ) -> Result<Vec<u8>> { let crypto_provider = self.can_provide_crypto()?; let op = PsaAeadEncrypt { key_name, alg: encrypt_alg, nonce: nonce.to_vec().into(), additional_data: additional_data.to_vec().into(), plaintext: plaintext.to_vec().into(), }; let encrypt_res = self.op_client.process_operation( NativeOperation::PsaAeadEncrypt(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaAeadEncrypt(res) = encrypt_res { Ok(res.ciphertext.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Decrypt and authenticate a short message. /// /// The key intended for decrypting **must** have its `decrypt` flag set /// to `true` in its [key policy](https://docs.rs/parsec-interface/*/parsec_interface/operations/psa_key_attributes/struct.Policy.html). /// /// The decryption will be performed with the algorithm defined in `alg`, /// but only after checking that the key policy and type conform with it. /// /// `nonce` must be appropriate for the selected `alg`. /// /// For algorithms where the encrypted data and the authentication tag are defined as separate inputs, /// `ciphertext` must contain the encrypted data followed by the authentication data. /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_aead_decrypt.html#specific-response-status-codes). pub fn psa_aead_decrypt( &self, key_name: String, encrypt_alg: Aead, nonce: &[u8], additional_data: &[u8], ciphertext: &[u8], ) -> Result<Vec<u8>> { let crypto_provider = self.can_provide_crypto()?; let op = PsaAeadDecrypt { key_name, alg: encrypt_alg, nonce: nonce.to_vec().into(), additional_data: additional_data.to_vec().into(), ciphertext: ciphertext.to_vec().into(), }; let decrypt_res = self.op_client.process_operation( NativeOperation::PsaAeadDecrypt(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaAeadDecrypt(res) = decrypt_res { Ok(res.plaintext.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Perform a raw key agreement. /// /// The provided private key **must** have its `derive` flag set /// to `true` in its [key policy](https://docs.rs/parsec-interface/*/parsec_interface/operations/psa_key_attributes/struct.Policy.html). /// /// The raw_key_agreement will be performed with the algorithm defined in `alg`, /// but only after checking that the key policy and type conform with it. /// /// `peer_key` must be the peer public key to use in the raw key derivation. It must /// be in a format supported by [`PsaImportKey`](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_import_key.html). /// /// # Errors /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_raw_key_agreement.html#specific-response-status-codes). pub fn psa_raw_key_agreement( &self, alg: RawKeyAgreement, private_key_name: String, peer_key: &[u8], ) -> Result<Vec<u8>> { let op = PsaRawKeyAgreement { alg, private_key_name, peer_key: Zeroizing::new(peer_key.to_vec()), }; let crypto_provider = self.can_provide_crypto()?; let raw_key_agreement_res = self.op_client.process_operation( NativeOperation::PsaRawKeyAgreement(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaRawKeyAgreement(res) = raw_key_agreement_res { Ok(res.shared_secret.expose_secret().to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } /// **[Cryptographic Operation]** Generate some random bytes. /// /// Generates a sequence of random bytes and returns them to the user. /// /// # Errors /// /// If this method returns an error, no bytes will have been generated. /// /// If the implicit client provider is `ProviderID::Core`, a client error /// of `InvalidProvider` type is returned. /// /// If the implicit client provider has not been set, a client error of /// `NoProvider` type is returned. /// /// See the operation-specific response codes returned by the service /// [here](https://parallaxsecond.github.io/parsec-book/parsec_client/operations/psa_generate_random.html). pub fn psa_generate_random(&self, nbytes: usize) -> Result<Vec<u8>> { let crypto_provider = self.can_provide_crypto()?; let op = PsaGenerateRandom { size: nbytes }; let res = self.op_client.process_operation( NativeOperation::PsaGenerateRandom(op), crypto_provider, &self.auth_data, )?; if let NativeResult::PsaGenerateRandom(res) = res { Ok(res.random_bytes.to_vec()) } else { // Should really not be reached given the checks we do, but it's not impossible if some // changes happen in the interface Err(Error::Client(ClientErrorKind::InvalidServiceResponseType)) } } fn can_provide_crypto(&self) -> Result<ProviderID> { match self.implicit_provider { None => Err(Error::Client(ClientErrorKind::NoProvider)), Some(ProviderID::Core) => Err(Error::Client(ClientErrorKind::InvalidProvider)), Some(crypto_provider) => Ok(crypto_provider), } } }