qsafe-sdk 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +134 -0
- data/Rakefile +10 -0
- data/docs/APIKeysApi.md +427 -0
- data/docs/ApiKey.md +40 -0
- data/docs/AuthResponse.md +20 -0
- data/docs/AuthResponseData.md +26 -0
- data/docs/AuthenticationApi.md +276 -0
- data/docs/ChangePassword200Response.md +20 -0
- data/docs/ChangePasswordRequest.md +20 -0
- data/docs/CreateApiKey201Response.md +20 -0
- data/docs/CreateApiKey201ResponseData.md +20 -0
- data/docs/CreateApiKeyRequest.md +28 -0
- data/docs/CryptographicOperationsApi.md +331 -0
- data/docs/DebugApi.md +84 -0
- data/docs/DebugRedisTest200Response.md +30 -0
- data/docs/DebugRedisTest200ResponseRateLimitTest.md +22 -0
- data/docs/DebugRedisTest200ResponseServicesStatus.md +24 -0
- data/docs/DebugRedisTest500Response.md +20 -0
- data/docs/DecryptData200Response.md +20 -0
- data/docs/DecryptData200ResponseData.md +24 -0
- data/docs/DecryptRequest.md +28 -0
- data/docs/DecryptRequestEphemeralCrypto.md +24 -0
- data/docs/EncryptData200Response.md +20 -0
- data/docs/EncryptData200ResponseData.md +28 -0
- data/docs/EncryptData200ResponseDataEphemeralStorage.md +22 -0
- data/docs/EncryptRequest.md +26 -0
- data/docs/EncryptRequestEphemeralStorage.md +22 -0
- data/docs/Error.md +28 -0
- data/docs/GenerateKeypair201Response.md +20 -0
- data/docs/GenerateKeypairRequest.md +24 -0
- data/docs/GenerateKeypairRequestKeyPolicy.md +20 -0
- data/docs/GetApiKey200Response.md +20 -0
- data/docs/GetApiKeyUsage200Response.md +20 -0
- data/docs/GetApiKeyUsage200ResponseData.md +22 -0
- data/docs/GetApiKeyUsage200ResponseDataDailyUsageInner.md +20 -0
- data/docs/GetAuthInfo200Response.md +20 -0
- data/docs/GetAuthInfo200ResponseData.md +26 -0
- data/docs/GetHealth200Response.md +22 -0
- data/docs/GetHealth200ResponseServices.md +22 -0
- data/docs/GetHealth200ResponseServicesApi.md +22 -0
- data/docs/GetHealth200ResponseServicesEphemeralStorage.md +18 -0
- data/docs/GetHealth200ResponseServicesRedis.md +20 -0
- data/docs/GetRateLimitStatus200Response.md +20 -0
- data/docs/GetRateLimitStatus200ResponseData.md +22 -0
- data/docs/GetRateLimitStatus200ResponseDataCurrentUsage.md +22 -0
- data/docs/GetRateLimitStatus200ResponseDataLimits.md +22 -0
- data/docs/GetRateLimitStatus200ResponseDataResetTimes.md +22 -0
- data/docs/HealthApi.md +69 -0
- data/docs/Keypair.md +40 -0
- data/docs/KeypairsApi.md +341 -0
- data/docs/ListApiKeys200Response.md +20 -0
- data/docs/ListApiKeys200ResponseData.md +22 -0
- data/docs/ListApiKeys200ResponseDataPagination.md +22 -0
- data/docs/ListKeypairs200Response.md +20 -0
- data/docs/ListKeypairs200ResponseData.md +22 -0
- data/docs/ListKeypairs200ResponseDataPagination.md +22 -0
- data/docs/LoginRequest.md +20 -0
- data/docs/RegisterRequest.md +24 -0
- data/docs/RevokeKeypair200Response.md +22 -0
- data/docs/RevokeKeypairRequest.md +22 -0
- data/docs/RotateApiKey200Response.md +20 -0
- data/docs/RotateApiKey200ResponseData.md +20 -0
- data/docs/SignData200Response.md +20 -0
- data/docs/SignData200ResponseData.md +30 -0
- data/docs/SignData200ResponseDataEphemeralStorage.md +22 -0
- data/docs/SignRequest.md +26 -0
- data/docs/SignRequestEphemeralStorage.md +20 -0
- data/docs/UpdateApiKeyRequest.md +28 -0
- data/docs/UpdateKeypair200Response.md +20 -0
- data/docs/UpdateKeypairRequest.md +24 -0
- data/docs/User.md +32 -0
- data/docs/UtilitiesApi.md +81 -0
- data/docs/VerifyRequest.md +26 -0
- data/docs/VerifySignature200Response.md +20 -0
- data/docs/VerifySignature200ResponseData.md +22 -0
- data/docs/VerifySignature200ResponseDataSignatureInfo.md +20 -0
- data/docs/VerifySignature200ResponseDataVerificationResult.md +22 -0
- data/git_push.sh +57 -0
- data/lib/qsafe/api/api_keys_api.rb +430 -0
- data/lib/qsafe/api/authentication_api.rb +275 -0
- data/lib/qsafe/api/cryptographic_operations_api.rb +314 -0
- data/lib/qsafe/api/debug_api.rb +79 -0
- data/lib/qsafe/api/health_api.rb +79 -0
- data/lib/qsafe/api/keypairs_api.rb +345 -0
- data/lib/qsafe/api/utilities_api.rb +79 -0
- data/lib/qsafe/api_client.rb +394 -0
- data/lib/qsafe/api_error.rb +58 -0
- data/lib/qsafe/configuration.rb +327 -0
- data/lib/qsafe/models/api_key.rb +325 -0
- data/lib/qsafe/models/auth_response.rb +223 -0
- data/lib/qsafe/models/auth_response_data.rb +242 -0
- data/lib/qsafe/models/change_password200_response.rb +223 -0
- data/lib/qsafe/models/change_password_request.rb +256 -0
- data/lib/qsafe/models/create_api_key201_response.rb +233 -0
- data/lib/qsafe/models/create_api_key_request.rb +350 -0
- data/lib/qsafe/models/debug_redis_test200_response.rb +304 -0
- data/lib/qsafe/models/debug_redis_test200_response_rate_limit_test.rb +232 -0
- data/lib/qsafe/models/debug_redis_test200_response_services_status.rb +241 -0
- data/lib/qsafe/models/debug_redis_test500_response.rb +223 -0
- data/lib/qsafe/models/decrypt_data200_response.rb +223 -0
- data/lib/qsafe/models/decrypt_data200_response_data.rb +242 -0
- data/lib/qsafe/models/decrypt_request.rb +301 -0
- data/lib/qsafe/models/decrypt_request_ephemeral_crypto.rb +276 -0
- data/lib/qsafe/models/encrypt_data200_response.rb +223 -0
- data/lib/qsafe/models/encrypt_data200_response_data.rb +263 -0
- data/lib/qsafe/models/encrypt_request.rb +322 -0
- data/lib/qsafe/models/encrypt_request_ephemeral_storage.rb +289 -0
- data/lib/qsafe/models/error.rb +275 -0
- data/lib/qsafe/models/generate_keypair201_response.rb +233 -0
- data/lib/qsafe/models/generate_keypair_request.rb +297 -0
- data/lib/qsafe/models/generate_keypair_request_key_policy.rb +266 -0
- data/lib/qsafe/models/get_api_key200_response.rb +223 -0
- data/lib/qsafe/models/get_api_key_usage200_response.rb +223 -0
- data/lib/qsafe/models/get_api_key_usage200_response_data.rb +236 -0
- data/lib/qsafe/models/get_api_key_usage200_response_data_daily_usage_inner.rb +223 -0
- data/lib/qsafe/models/get_auth_info200_response.rb +223 -0
- data/lib/qsafe/models/get_auth_info200_response_data.rb +284 -0
- data/lib/qsafe/models/get_health200_response.rb +232 -0
- data/lib/qsafe/models/get_health200_response_services.rb +232 -0
- data/lib/qsafe/models/get_health200_response_services_api.rb +232 -0
- data/lib/qsafe/models/get_health200_response_services_ephemeral_storage.rb +214 -0
- data/lib/qsafe/models/get_health200_response_services_redis.rb +223 -0
- data/lib/qsafe/models/get_rate_limit_status200_response.rb +223 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data.rb +232 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data_current_usage.rb +232 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data_limits.rb +232 -0
- data/lib/qsafe/models/get_rate_limit_status200_response_data_reset_times.rb +232 -0
- data/lib/qsafe/models/keypair.rb +379 -0
- data/lib/qsafe/models/list_api_keys200_response.rb +223 -0
- data/lib/qsafe/models/list_api_keys200_response_data.rb +234 -0
- data/lib/qsafe/models/list_api_keys200_response_data_pagination.rb +232 -0
- data/lib/qsafe/models/list_keypairs200_response.rb +223 -0
- data/lib/qsafe/models/list_keypairs200_response_data.rb +234 -0
- data/lib/qsafe/models/list_keypairs200_response_data_pagination.rb +232 -0
- data/lib/qsafe/models/login_request.rb +237 -0
- data/lib/qsafe/models/register_request.rb +345 -0
- data/lib/qsafe/models/revoke_keypair200_response.rb +232 -0
- data/lib/qsafe/models/revoke_keypair_request.rb +301 -0
- data/lib/qsafe/models/rotate_api_key200_response.rb +232 -0
- data/lib/qsafe/models/sign_data200_response.rb +223 -0
- data/lib/qsafe/models/sign_data200_response_data.rb +262 -0
- data/lib/qsafe/models/sign_request.rb +321 -0
- data/lib/qsafe/models/sign_request_ephemeral_storage.rb +279 -0
- data/lib/qsafe/models/update_api_key_request.rb +343 -0
- data/lib/qsafe/models/update_keypair200_response.rb +223 -0
- data/lib/qsafe/models/update_keypair_request.rb +317 -0
- data/lib/qsafe/models/user.rb +293 -0
- data/lib/qsafe/models/verify_request.rb +389 -0
- data/lib/qsafe/models/verify_signature200_response.rb +223 -0
- data/lib/qsafe/models/verify_signature200_response_data.rb +251 -0
- data/lib/qsafe/version.rb +15 -0
- data/lib/qsafe-sdk/api/api_keys_api.rb +430 -0
- data/lib/qsafe-sdk/api/authentication_api.rb +275 -0
- data/lib/qsafe-sdk/api/cryptographic_operations_api.rb +314 -0
- data/lib/qsafe-sdk/api/debug_api.rb +79 -0
- data/lib/qsafe-sdk/api/health_api.rb +79 -0
- data/lib/qsafe-sdk/api/keypairs_api.rb +345 -0
- data/lib/qsafe-sdk/api/utilities_api.rb +79 -0
- data/lib/qsafe-sdk/api_client.rb +394 -0
- data/lib/qsafe-sdk/api_error.rb +58 -0
- data/lib/qsafe-sdk/configuration.rb +327 -0
- data/lib/qsafe-sdk/models/api_key.rb +345 -0
- data/lib/qsafe-sdk/models/auth_response.rb +223 -0
- data/lib/qsafe-sdk/models/auth_response_data.rb +252 -0
- data/lib/qsafe-sdk/models/change_password200_response.rb +223 -0
- data/lib/qsafe-sdk/models/change_password_request.rb +256 -0
- data/lib/qsafe-sdk/models/create_api_key201_response.rb +223 -0
- data/lib/qsafe-sdk/models/create_api_key201_response_data.rb +224 -0
- data/lib/qsafe-sdk/models/create_api_key_request.rb +350 -0
- data/lib/qsafe-sdk/models/debug_redis_test200_response.rb +304 -0
- data/lib/qsafe-sdk/models/debug_redis_test200_response_rate_limit_test.rb +232 -0
- data/lib/qsafe-sdk/models/debug_redis_test200_response_services_status.rb +241 -0
- data/lib/qsafe-sdk/models/debug_redis_test500_response.rb +223 -0
- data/lib/qsafe-sdk/models/decrypt_data200_response.rb +223 -0
- data/lib/qsafe-sdk/models/decrypt_data200_response_data.rb +242 -0
- data/lib/qsafe-sdk/models/decrypt_request.rb +301 -0
- data/lib/qsafe-sdk/models/decrypt_request_ephemeral_crypto.rb +276 -0
- data/lib/qsafe-sdk/models/encrypt_data200_response.rb +223 -0
- data/lib/qsafe-sdk/models/encrypt_data200_response_data.rb +262 -0
- data/lib/qsafe-sdk/models/encrypt_data200_response_data_ephemeral_storage.rb +235 -0
- data/lib/qsafe-sdk/models/encrypt_request.rb +322 -0
- data/lib/qsafe-sdk/models/encrypt_request_ephemeral_storage.rb +289 -0
- data/lib/qsafe-sdk/models/error.rb +275 -0
- data/lib/qsafe-sdk/models/generate_keypair201_response.rb +223 -0
- data/lib/qsafe-sdk/models/generate_keypair_request.rb +297 -0
- data/lib/qsafe-sdk/models/generate_keypair_request_key_policy.rb +266 -0
- data/lib/qsafe-sdk/models/get_api_key200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_api_key_usage200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_api_key_usage200_response_data.rb +236 -0
- data/lib/qsafe-sdk/models/get_api_key_usage200_response_data_daily_usage_inner.rb +223 -0
- data/lib/qsafe-sdk/models/get_auth_info200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_auth_info200_response_data.rb +284 -0
- data/lib/qsafe-sdk/models/get_health200_response.rb +232 -0
- data/lib/qsafe-sdk/models/get_health200_response_services.rb +232 -0
- data/lib/qsafe-sdk/models/get_health200_response_services_api.rb +232 -0
- data/lib/qsafe-sdk/models/get_health200_response_services_ephemeral_storage.rb +214 -0
- data/lib/qsafe-sdk/models/get_health200_response_services_redis.rb +223 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response.rb +223 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data.rb +232 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data_current_usage.rb +232 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data_limits.rb +232 -0
- data/lib/qsafe-sdk/models/get_rate_limit_status200_response_data_reset_times.rb +232 -0
- data/lib/qsafe-sdk/models/keypair.rb +379 -0
- data/lib/qsafe-sdk/models/list_api_keys200_response.rb +223 -0
- data/lib/qsafe-sdk/models/list_api_keys200_response_data.rb +234 -0
- data/lib/qsafe-sdk/models/list_api_keys200_response_data_pagination.rb +232 -0
- data/lib/qsafe-sdk/models/list_keypairs200_response.rb +223 -0
- data/lib/qsafe-sdk/models/list_keypairs200_response_data.rb +234 -0
- data/lib/qsafe-sdk/models/list_keypairs200_response_data_pagination.rb +232 -0
- data/lib/qsafe-sdk/models/login_request.rb +237 -0
- data/lib/qsafe-sdk/models/register_request.rb +345 -0
- data/lib/qsafe-sdk/models/revoke_keypair200_response.rb +232 -0
- data/lib/qsafe-sdk/models/revoke_keypair_request.rb +301 -0
- data/lib/qsafe-sdk/models/rotate_api_key200_response.rb +223 -0
- data/lib/qsafe-sdk/models/rotate_api_key200_response_data.rb +224 -0
- data/lib/qsafe-sdk/models/sign_data200_response.rb +223 -0
- data/lib/qsafe-sdk/models/sign_data200_response_data.rb +270 -0
- data/lib/qsafe-sdk/models/sign_data200_response_data_ephemeral_storage.rb +234 -0
- data/lib/qsafe-sdk/models/sign_request.rb +321 -0
- data/lib/qsafe-sdk/models/sign_request_ephemeral_storage.rb +279 -0
- data/lib/qsafe-sdk/models/update_api_key_request.rb +343 -0
- data/lib/qsafe-sdk/models/update_keypair200_response.rb +223 -0
- data/lib/qsafe-sdk/models/update_keypair_request.rb +317 -0
- data/lib/qsafe-sdk/models/user.rb +312 -0
- data/lib/qsafe-sdk/models/verify_request.rb +389 -0
- data/lib/qsafe-sdk/models/verify_signature200_response.rb +223 -0
- data/lib/qsafe-sdk/models/verify_signature200_response_data.rb +232 -0
- data/lib/qsafe-sdk/models/verify_signature200_response_data_signature_info.rb +223 -0
- data/lib/qsafe-sdk/models/verify_signature200_response_data_verification_result.rb +233 -0
- data/lib/qsafe-sdk/version.rb +15 -0
- data/lib/qsafe-sdk.rb +114 -0
- data/lib/qsafe.rb +108 -0
- data/qsafe-sdk.gemspec +39 -0
- data/qsafe.gemspec +39 -0
- data/spec/api/api_keys_api_spec.rb +105 -0
- data/spec/api/authentication_api_spec.rb +78 -0
- data/spec/api/cryptographic_operations_api_spec.rb +85 -0
- data/spec/api/debug_api_spec.rb +46 -0
- data/spec/api/health_api_spec.rb +46 -0
- data/spec/api/keypairs_api_spec.rb +89 -0
- data/spec/api/utilities_api_spec.rb +46 -0
- data/spec/models/api_key_spec.rb +94 -0
- data/spec/models/auth_response_data_spec.rb +54 -0
- data/spec/models/auth_response_spec.rb +42 -0
- data/spec/models/change_password200_response_spec.rb +42 -0
- data/spec/models/change_password_request_spec.rb +42 -0
- data/spec/models/create_api_key201_response_data_spec.rb +42 -0
- data/spec/models/create_api_key201_response_spec.rb +48 -0
- data/spec/models/create_api_key_request_spec.rb +70 -0
- data/spec/models/debug_redis_test200_response_rate_limit_test_spec.rb +48 -0
- data/spec/models/debug_redis_test200_response_services_status_spec.rb +54 -0
- data/spec/models/debug_redis_test200_response_spec.rb +76 -0
- data/spec/models/debug_redis_test500_response_spec.rb +42 -0
- data/spec/models/decrypt_data200_response_data_spec.rb +54 -0
- data/spec/models/decrypt_data200_response_spec.rb +42 -0
- data/spec/models/decrypt_request_ephemeral_crypto_spec.rb +54 -0
- data/spec/models/decrypt_request_spec.rb +66 -0
- data/spec/models/encrypt_data200_response_data_ephemeral_storage_spec.rb +48 -0
- data/spec/models/encrypt_data200_response_data_spec.rb +66 -0
- data/spec/models/encrypt_data200_response_spec.rb +42 -0
- data/spec/models/encrypt_request_ephemeral_storage_spec.rb +48 -0
- data/spec/models/encrypt_request_spec.rb +64 -0
- data/spec/models/error_spec.rb +66 -0
- data/spec/models/generate_keypair201_response_spec.rb +48 -0
- data/spec/models/generate_keypair_request_key_policy_spec.rb +46 -0
- data/spec/models/generate_keypair_request_spec.rb +62 -0
- data/spec/models/get_api_key200_response_spec.rb +42 -0
- data/spec/models/get_api_key_usage200_response_data_daily_usage_inner_spec.rb +42 -0
- data/spec/models/get_api_key_usage200_response_data_spec.rb +48 -0
- data/spec/models/get_api_key_usage200_response_spec.rb +42 -0
- data/spec/models/get_auth_info200_response_data_spec.rb +64 -0
- data/spec/models/get_auth_info200_response_spec.rb +42 -0
- data/spec/models/get_health200_response_services_api_spec.rb +48 -0
- data/spec/models/get_health200_response_services_ephemeral_storage_spec.rb +36 -0
- data/spec/models/get_health200_response_services_redis_spec.rb +42 -0
- data/spec/models/get_health200_response_services_spec.rb +48 -0
- data/spec/models/get_health200_response_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_current_usage_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_limits_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_reset_times_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_data_spec.rb +48 -0
- data/spec/models/get_rate_limit_status200_response_spec.rb +42 -0
- data/spec/models/keypair_spec.rb +114 -0
- data/spec/models/list_api_keys200_response_data_pagination_spec.rb +48 -0
- data/spec/models/list_api_keys200_response_data_spec.rb +48 -0
- data/spec/models/list_api_keys200_response_spec.rb +42 -0
- data/spec/models/list_keypairs200_response_data_pagination_spec.rb +48 -0
- data/spec/models/list_keypairs200_response_data_spec.rb +48 -0
- data/spec/models/list_keypairs200_response_spec.rb +42 -0
- data/spec/models/login_request_spec.rb +42 -0
- data/spec/models/register_request_spec.rb +54 -0
- data/spec/models/revoke_keypair200_response_spec.rb +48 -0
- data/spec/models/revoke_keypair_request_spec.rb +52 -0
- data/spec/models/rotate_api_key200_response_data_spec.rb +42 -0
- data/spec/models/rotate_api_key200_response_spec.rb +48 -0
- data/spec/models/sign_data200_response_data_ephemeral_storage_spec.rb +48 -0
- data/spec/models/sign_data200_response_data_spec.rb +66 -0
- data/spec/models/sign_data200_response_spec.rb +42 -0
- data/spec/models/sign_request_ephemeral_storage_spec.rb +42 -0
- data/spec/models/sign_request_spec.rb +64 -0
- data/spec/models/update_api_key_request_spec.rb +70 -0
- data/spec/models/update_keypair200_response_spec.rb +42 -0
- data/spec/models/update_keypair_request_spec.rb +58 -0
- data/spec/models/user_spec.rb +70 -0
- data/spec/models/verify_request_spec.rb +64 -0
- data/spec/models/verify_signature200_response_data_signature_info_spec.rb +42 -0
- data/spec/models/verify_signature200_response_data_spec.rb +60 -0
- data/spec/models/verify_signature200_response_data_verification_result_spec.rb +48 -0
- data/spec/models/verify_signature200_response_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- metadata +477 -0
|
@@ -0,0 +1,331 @@
|
|
|
1
|
+
# QSafe::CryptographicOperationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://rushikesh66-pqc-api.hf.space*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**decrypt_data**](CryptographicOperationsApi.md#decrypt_data) | **POST** /keypairs/{keypairId}/decrypt | Decrypt data with a keypair's private key |
|
|
8
|
+
| [**encrypt_data**](CryptographicOperationsApi.md#encrypt_data) | **POST** /keypairs/{keypairId}/encrypt | Encrypt data with a keypair's public key |
|
|
9
|
+
| [**sign_data**](CryptographicOperationsApi.md#sign_data) | **POST** /keypairs/{keypairId}/sign | Sign data with a keypair's private key |
|
|
10
|
+
| [**verify_signature**](CryptographicOperationsApi.md#verify_signature) | **POST** /keypairs/{keypairId}/verify | Verify a signature |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## decrypt_data
|
|
14
|
+
|
|
15
|
+
> <DecryptData200Response> decrypt_data(keypair_id, decrypt_request)
|
|
16
|
+
|
|
17
|
+
Decrypt data with a keypair's private key
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'qsafe-sdk'
|
|
24
|
+
# setup authorization
|
|
25
|
+
QSafe.configure do |config|
|
|
26
|
+
# Configure API key authorization: ApiKeyHeader
|
|
27
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
30
|
+
|
|
31
|
+
# Configure API key authorization: ApiKeyQuery
|
|
32
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
34
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
35
|
+
|
|
36
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
37
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
api_instance = QSafe::CryptographicOperationsApi.new
|
|
41
|
+
keypair_id = '123e4567-e89b-12d3-a456-426614174000' # String | UUID v4 keypair identifier
|
|
42
|
+
decrypt_request = QSafe::DecryptRequest.new # DecryptRequest |
|
|
43
|
+
|
|
44
|
+
begin
|
|
45
|
+
# Decrypt data with a keypair's private key
|
|
46
|
+
result = api_instance.decrypt_data(keypair_id, decrypt_request)
|
|
47
|
+
p result
|
|
48
|
+
rescue QSafe::ApiError => e
|
|
49
|
+
puts "Error when calling CryptographicOperationsApi->decrypt_data: #{e}"
|
|
50
|
+
end
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
#### Using the decrypt_data_with_http_info variant
|
|
54
|
+
|
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
|
56
|
+
|
|
57
|
+
> <Array(<DecryptData200Response>, Integer, Hash)> decrypt_data_with_http_info(keypair_id, decrypt_request)
|
|
58
|
+
|
|
59
|
+
```ruby
|
|
60
|
+
begin
|
|
61
|
+
# Decrypt data with a keypair's private key
|
|
62
|
+
data, status_code, headers = api_instance.decrypt_data_with_http_info(keypair_id, decrypt_request)
|
|
63
|
+
p status_code # => 2xx
|
|
64
|
+
p headers # => { ... }
|
|
65
|
+
p data # => <DecryptData200Response>
|
|
66
|
+
rescue QSafe::ApiError => e
|
|
67
|
+
puts "Error when calling CryptographicOperationsApi->decrypt_data_with_http_info: #{e}"
|
|
68
|
+
end
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
| Name | Type | Description | Notes |
|
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
|
75
|
+
| **keypair_id** | **String** | UUID v4 keypair identifier | |
|
|
76
|
+
| **decrypt_request** | [**DecryptRequest**](DecryptRequest.md) | | |
|
|
77
|
+
|
|
78
|
+
### Return type
|
|
79
|
+
|
|
80
|
+
[**DecryptData200Response**](DecryptData200Response.md)
|
|
81
|
+
|
|
82
|
+
### Authorization
|
|
83
|
+
|
|
84
|
+
[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
|
|
85
|
+
|
|
86
|
+
### HTTP request headers
|
|
87
|
+
|
|
88
|
+
- **Content-Type**: application/json
|
|
89
|
+
- **Accept**: application/json
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
## encrypt_data
|
|
93
|
+
|
|
94
|
+
> <EncryptData200Response> encrypt_data(keypair_id, encrypt_request)
|
|
95
|
+
|
|
96
|
+
Encrypt data with a keypair's public key
|
|
97
|
+
|
|
98
|
+
Uses ML-KEM (Kyber). The keypair must use a `KYBER*` algorithm. Optionally stores result in ephemeral storage and returns an `ephemeral_id` for later decryption without passing raw ciphertext.
|
|
99
|
+
|
|
100
|
+
### Examples
|
|
101
|
+
|
|
102
|
+
```ruby
|
|
103
|
+
require 'time'
|
|
104
|
+
require 'qsafe-sdk'
|
|
105
|
+
# setup authorization
|
|
106
|
+
QSafe.configure do |config|
|
|
107
|
+
# Configure API key authorization: ApiKeyHeader
|
|
108
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
110
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
111
|
+
|
|
112
|
+
# Configure API key authorization: ApiKeyQuery
|
|
113
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
115
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
116
|
+
|
|
117
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
118
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
api_instance = QSafe::CryptographicOperationsApi.new
|
|
122
|
+
keypair_id = '123e4567-e89b-12d3-a456-426614174000' # String | UUID v4 keypair identifier
|
|
123
|
+
encrypt_request = QSafe::EncryptRequest.new({plaintext: 'Hello, this is sensitive data to encrypt'}) # EncryptRequest |
|
|
124
|
+
|
|
125
|
+
begin
|
|
126
|
+
# Encrypt data with a keypair's public key
|
|
127
|
+
result = api_instance.encrypt_data(keypair_id, encrypt_request)
|
|
128
|
+
p result
|
|
129
|
+
rescue QSafe::ApiError => e
|
|
130
|
+
puts "Error when calling CryptographicOperationsApi->encrypt_data: #{e}"
|
|
131
|
+
end
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
#### Using the encrypt_data_with_http_info variant
|
|
135
|
+
|
|
136
|
+
This returns an Array which contains the response data, status code and headers.
|
|
137
|
+
|
|
138
|
+
> <Array(<EncryptData200Response>, Integer, Hash)> encrypt_data_with_http_info(keypair_id, encrypt_request)
|
|
139
|
+
|
|
140
|
+
```ruby
|
|
141
|
+
begin
|
|
142
|
+
# Encrypt data with a keypair's public key
|
|
143
|
+
data, status_code, headers = api_instance.encrypt_data_with_http_info(keypair_id, encrypt_request)
|
|
144
|
+
p status_code # => 2xx
|
|
145
|
+
p headers # => { ... }
|
|
146
|
+
p data # => <EncryptData200Response>
|
|
147
|
+
rescue QSafe::ApiError => e
|
|
148
|
+
puts "Error when calling CryptographicOperationsApi->encrypt_data_with_http_info: #{e}"
|
|
149
|
+
end
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
| Name | Type | Description | Notes |
|
|
155
|
+
| ---- | ---- | ----------- | ----- |
|
|
156
|
+
| **keypair_id** | **String** | UUID v4 keypair identifier | |
|
|
157
|
+
| **encrypt_request** | [**EncryptRequest**](EncryptRequest.md) | | |
|
|
158
|
+
|
|
159
|
+
### Return type
|
|
160
|
+
|
|
161
|
+
[**EncryptData200Response**](EncryptData200Response.md)
|
|
162
|
+
|
|
163
|
+
### Authorization
|
|
164
|
+
|
|
165
|
+
[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
|
|
166
|
+
|
|
167
|
+
### HTTP request headers
|
|
168
|
+
|
|
169
|
+
- **Content-Type**: application/json
|
|
170
|
+
- **Accept**: application/json
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
## sign_data
|
|
174
|
+
|
|
175
|
+
> <SignData200Response> sign_data(keypair_id, sign_request)
|
|
176
|
+
|
|
177
|
+
Sign data with a keypair's private key
|
|
178
|
+
|
|
179
|
+
Uses ML-DSA (Dilithium). The keypair must use a `DILITHIUM*` algorithm.
|
|
180
|
+
|
|
181
|
+
### Examples
|
|
182
|
+
|
|
183
|
+
```ruby
|
|
184
|
+
require 'time'
|
|
185
|
+
require 'qsafe-sdk'
|
|
186
|
+
# setup authorization
|
|
187
|
+
QSafe.configure do |config|
|
|
188
|
+
# Configure API key authorization: ApiKeyHeader
|
|
189
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
191
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
192
|
+
|
|
193
|
+
# Configure API key authorization: ApiKeyQuery
|
|
194
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
195
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
196
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
197
|
+
|
|
198
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
199
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
api_instance = QSafe::CryptographicOperationsApi.new
|
|
203
|
+
keypair_id = '123e4567-e89b-12d3-a456-426614174000' # String | UUID v4 keypair identifier
|
|
204
|
+
sign_request = QSafe::SignRequest.new({message: 'I hereby approve this financial transaction of $10,000'}) # SignRequest |
|
|
205
|
+
|
|
206
|
+
begin
|
|
207
|
+
# Sign data with a keypair's private key
|
|
208
|
+
result = api_instance.sign_data(keypair_id, sign_request)
|
|
209
|
+
p result
|
|
210
|
+
rescue QSafe::ApiError => e
|
|
211
|
+
puts "Error when calling CryptographicOperationsApi->sign_data: #{e}"
|
|
212
|
+
end
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
#### Using the sign_data_with_http_info variant
|
|
216
|
+
|
|
217
|
+
This returns an Array which contains the response data, status code and headers.
|
|
218
|
+
|
|
219
|
+
> <Array(<SignData200Response>, Integer, Hash)> sign_data_with_http_info(keypair_id, sign_request)
|
|
220
|
+
|
|
221
|
+
```ruby
|
|
222
|
+
begin
|
|
223
|
+
# Sign data with a keypair's private key
|
|
224
|
+
data, status_code, headers = api_instance.sign_data_with_http_info(keypair_id, sign_request)
|
|
225
|
+
p status_code # => 2xx
|
|
226
|
+
p headers # => { ... }
|
|
227
|
+
p data # => <SignData200Response>
|
|
228
|
+
rescue QSafe::ApiError => e
|
|
229
|
+
puts "Error when calling CryptographicOperationsApi->sign_data_with_http_info: #{e}"
|
|
230
|
+
end
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Parameters
|
|
234
|
+
|
|
235
|
+
| Name | Type | Description | Notes |
|
|
236
|
+
| ---- | ---- | ----------- | ----- |
|
|
237
|
+
| **keypair_id** | **String** | UUID v4 keypair identifier | |
|
|
238
|
+
| **sign_request** | [**SignRequest**](SignRequest.md) | | |
|
|
239
|
+
|
|
240
|
+
### Return type
|
|
241
|
+
|
|
242
|
+
[**SignData200Response**](SignData200Response.md)
|
|
243
|
+
|
|
244
|
+
### Authorization
|
|
245
|
+
|
|
246
|
+
[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
|
|
247
|
+
|
|
248
|
+
### HTTP request headers
|
|
249
|
+
|
|
250
|
+
- **Content-Type**: application/json
|
|
251
|
+
- **Accept**: application/json
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
## verify_signature
|
|
255
|
+
|
|
256
|
+
> <VerifySignature200Response> verify_signature(keypair_id, verify_request)
|
|
257
|
+
|
|
258
|
+
Verify a signature
|
|
259
|
+
|
|
260
|
+
### Examples
|
|
261
|
+
|
|
262
|
+
```ruby
|
|
263
|
+
require 'time'
|
|
264
|
+
require 'qsafe-sdk'
|
|
265
|
+
# setup authorization
|
|
266
|
+
QSafe.configure do |config|
|
|
267
|
+
# Configure API key authorization: ApiKeyHeader
|
|
268
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
269
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
270
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
271
|
+
|
|
272
|
+
# Configure API key authorization: ApiKeyQuery
|
|
273
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
274
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
275
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
276
|
+
|
|
277
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
278
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
279
|
+
end
|
|
280
|
+
|
|
281
|
+
api_instance = QSafe::CryptographicOperationsApi.new
|
|
282
|
+
keypair_id = '123e4567-e89b-12d3-a456-426614174000' # String | UUID v4 keypair identifier
|
|
283
|
+
verify_request = QSafe::VerifyRequest.new({message: 'I hereby approve this financial transaction of $10,000'}) # VerifyRequest |
|
|
284
|
+
|
|
285
|
+
begin
|
|
286
|
+
# Verify a signature
|
|
287
|
+
result = api_instance.verify_signature(keypair_id, verify_request)
|
|
288
|
+
p result
|
|
289
|
+
rescue QSafe::ApiError => e
|
|
290
|
+
puts "Error when calling CryptographicOperationsApi->verify_signature: #{e}"
|
|
291
|
+
end
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
#### Using the verify_signature_with_http_info variant
|
|
295
|
+
|
|
296
|
+
This returns an Array which contains the response data, status code and headers.
|
|
297
|
+
|
|
298
|
+
> <Array(<VerifySignature200Response>, Integer, Hash)> verify_signature_with_http_info(keypair_id, verify_request)
|
|
299
|
+
|
|
300
|
+
```ruby
|
|
301
|
+
begin
|
|
302
|
+
# Verify a signature
|
|
303
|
+
data, status_code, headers = api_instance.verify_signature_with_http_info(keypair_id, verify_request)
|
|
304
|
+
p status_code # => 2xx
|
|
305
|
+
p headers # => { ... }
|
|
306
|
+
p data # => <VerifySignature200Response>
|
|
307
|
+
rescue QSafe::ApiError => e
|
|
308
|
+
puts "Error when calling CryptographicOperationsApi->verify_signature_with_http_info: #{e}"
|
|
309
|
+
end
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### Parameters
|
|
313
|
+
|
|
314
|
+
| Name | Type | Description | Notes |
|
|
315
|
+
| ---- | ---- | ----------- | ----- |
|
|
316
|
+
| **keypair_id** | **String** | UUID v4 keypair identifier | |
|
|
317
|
+
| **verify_request** | [**VerifyRequest**](VerifyRequest.md) | | |
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
[**VerifySignature200Response**](VerifySignature200Response.md)
|
|
322
|
+
|
|
323
|
+
### Authorization
|
|
324
|
+
|
|
325
|
+
[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
|
|
326
|
+
|
|
327
|
+
### HTTP request headers
|
|
328
|
+
|
|
329
|
+
- **Content-Type**: application/json
|
|
330
|
+
- **Accept**: application/json
|
|
331
|
+
|
data/docs/DebugApi.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# QSafe::DebugApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://rushikesh66-pqc-api.hf.space*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**debug_redis_test**](DebugApi.md#debug_redis_test) | **GET** /debug/redis-test | Test Redis and internal services |
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## debug_redis_test
|
|
11
|
+
|
|
12
|
+
> <DebugRedisTest200Response> debug_redis_test
|
|
13
|
+
|
|
14
|
+
Test Redis and internal services
|
|
15
|
+
|
|
16
|
+
⚠️ Disable in production. Tests Redis connectivity and all enhanced services.
|
|
17
|
+
|
|
18
|
+
### Examples
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'time'
|
|
22
|
+
require 'qsafe-sdk'
|
|
23
|
+
# setup authorization
|
|
24
|
+
QSafe.configure do |config|
|
|
25
|
+
# Configure API key authorization: ApiKeyHeader
|
|
26
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
28
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
29
|
+
|
|
30
|
+
# Configure API key authorization: ApiKeyQuery
|
|
31
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
34
|
+
|
|
35
|
+
# Configure Bearer authorization (JWT): BearerAuth
|
|
36
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
api_instance = QSafe::DebugApi.new
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# Test Redis and internal services
|
|
43
|
+
result = api_instance.debug_redis_test
|
|
44
|
+
p result
|
|
45
|
+
rescue QSafe::ApiError => e
|
|
46
|
+
puts "Error when calling DebugApi->debug_redis_test: #{e}"
|
|
47
|
+
end
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
#### Using the debug_redis_test_with_http_info variant
|
|
51
|
+
|
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
|
53
|
+
|
|
54
|
+
> <Array(<DebugRedisTest200Response>, Integer, Hash)> debug_redis_test_with_http_info
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
begin
|
|
58
|
+
# Test Redis and internal services
|
|
59
|
+
data, status_code, headers = api_instance.debug_redis_test_with_http_info
|
|
60
|
+
p status_code # => 2xx
|
|
61
|
+
p headers # => { ... }
|
|
62
|
+
p data # => <DebugRedisTest200Response>
|
|
63
|
+
rescue QSafe::ApiError => e
|
|
64
|
+
puts "Error when calling DebugApi->debug_redis_test_with_http_info: #{e}"
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
This endpoint does not need any parameter.
|
|
71
|
+
|
|
72
|
+
### Return type
|
|
73
|
+
|
|
74
|
+
[**DebugRedisTest200Response**](DebugRedisTest200Response.md)
|
|
75
|
+
|
|
76
|
+
### Authorization
|
|
77
|
+
|
|
78
|
+
[ApiKeyHeader](../README.md#ApiKeyHeader), [ApiKeyQuery](../README.md#ApiKeyQuery), [BearerAuth](../README.md#BearerAuth)
|
|
79
|
+
|
|
80
|
+
### HTTP request headers
|
|
81
|
+
|
|
82
|
+
- **Content-Type**: Not defined
|
|
83
|
+
- **Accept**: application/json
|
|
84
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# QSafe::DebugRedisTest200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **auth_type** | **String** | | [optional] |
|
|
9
|
+
| **database_size** | **Integer** | | [optional] |
|
|
10
|
+
| **keys_sample** | **Array<String>** | | [optional] |
|
|
11
|
+
| **ephemeral_stored** | **String** | | [optional] |
|
|
12
|
+
| **rate_limit_test** | [**DebugRedisTest200ResponseRateLimitTest**](DebugRedisTest200ResponseRateLimitTest.md) | | [optional] |
|
|
13
|
+
| **services_status** | [**DebugRedisTest200ResponseServicesStatus**](DebugRedisTest200ResponseServicesStatus.md) | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'qsafe-sdk'
|
|
19
|
+
|
|
20
|
+
instance = QSafe::DebugRedisTest200Response.new(
|
|
21
|
+
success: true,
|
|
22
|
+
auth_type: api_key,
|
|
23
|
+
database_size: 42,
|
|
24
|
+
keys_sample: ["user:123","session:456","rate_limit:789"],
|
|
25
|
+
ephemeral_stored: test-operation-id,
|
|
26
|
+
rate_limit_test: null,
|
|
27
|
+
services_status: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::DebugRedisTest200ResponseRateLimitTest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **allowed** | **Boolean** | | [optional] |
|
|
8
|
+
| **remaining** | **Integer** | | [optional] |
|
|
9
|
+
| **reset_time** | **Time** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::DebugRedisTest200ResponseRateLimitTest.new(
|
|
17
|
+
allowed: null,
|
|
18
|
+
remaining: null,
|
|
19
|
+
reset_time: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# QSafe::DebugRedisTest200ResponseServicesStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **api_key_middleware** | **String** | | [optional] |
|
|
8
|
+
| **usage_tracking** | **String** | | [optional] |
|
|
9
|
+
| **rate_limiting** | **String** | | [optional] |
|
|
10
|
+
| **security_monitoring** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'qsafe-sdk'
|
|
16
|
+
|
|
17
|
+
instance = QSafe::DebugRedisTest200ResponseServicesStatus.new(
|
|
18
|
+
api_key_middleware: initialized,
|
|
19
|
+
usage_tracking: initialized,
|
|
20
|
+
rate_limiting: initialized,
|
|
21
|
+
security_monitoring: initialized
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::DebugRedisTest500Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | **String** | | [optional] |
|
|
8
|
+
| **stack** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::DebugRedisTest500Response.new(
|
|
16
|
+
error: Redis connection failed,
|
|
17
|
+
stack: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::DecryptData200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **data** | [**DecryptData200ResponseData**](DecryptData200ResponseData.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::DecryptData200Response.new(
|
|
16
|
+
success: true,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# QSafe::DecryptData200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plaintext** | **String** | Decrypted plaintext | [optional] |
|
|
8
|
+
| **algorithm** | **String** | | [optional] |
|
|
9
|
+
| **keypair_id** | **String** | | [optional] |
|
|
10
|
+
| **decompression_used** | **Boolean** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'qsafe-sdk'
|
|
16
|
+
|
|
17
|
+
instance = QSafe::DecryptData200ResponseData.new(
|
|
18
|
+
plaintext: null,
|
|
19
|
+
algorithm: KYBER768,
|
|
20
|
+
keypair_id: null,
|
|
21
|
+
decompression_used: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# QSafe::DecryptRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ephemeral_id** | **String** | | [optional] |
|
|
8
|
+
| **ephemeral_crypto** | [**DecryptRequestEphemeralCrypto**](DecryptRequestEphemeralCrypto.md) | | [optional] |
|
|
9
|
+
| **ciphertext** | **String** | | [optional] |
|
|
10
|
+
| **encapsulated_key** | **String** | | [optional] |
|
|
11
|
+
| **force_decrypt** | **Boolean** | | [optional] |
|
|
12
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'qsafe-sdk'
|
|
18
|
+
|
|
19
|
+
instance = QSafe::DecryptRequest.new(
|
|
20
|
+
ephemeral_id: eph_1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234,
|
|
21
|
+
ephemeral_crypto: null,
|
|
22
|
+
ciphertext: dGVzdCBjaXBoZXJ0ZXh0,
|
|
23
|
+
encapsulated_key: dGVzdCBlbmNhcHN1bGF0ZWQga2V5,
|
|
24
|
+
force_decrypt: false,
|
|
25
|
+
metadata: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# QSafe::DecryptRequestEphemeralCrypto
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ciphertext** | **String** | | |
|
|
8
|
+
| **encapsulated_key** | **String** | | |
|
|
9
|
+
| **integrity_hash** | **String** | | [optional] |
|
|
10
|
+
| **expires_at** | **Time** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'qsafe-sdk'
|
|
16
|
+
|
|
17
|
+
instance = QSafe::DecryptRequestEphemeralCrypto.new(
|
|
18
|
+
ciphertext: dGVzdCBjaXBoZXJ0ZXh0,
|
|
19
|
+
encapsulated_key: dGVzdCBlbmNhcHN1bGF0ZWQga2V5,
|
|
20
|
+
integrity_hash: a1b2c3d4e5f6789012345678901234567890123456789012345678901234567890ab,
|
|
21
|
+
expires_at: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# QSafe::EncryptData200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | [optional] |
|
|
8
|
+
| **data** | [**EncryptData200ResponseData**](EncryptData200ResponseData.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'qsafe-sdk'
|
|
14
|
+
|
|
15
|
+
instance = QSafe::EncryptData200Response.new(
|
|
16
|
+
success: true,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# QSafe::EncryptData200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **operation_id** | **String** | | [optional] |
|
|
8
|
+
| **ciphertext** | **String** | Base64-encoded ciphertext | [optional] |
|
|
9
|
+
| **encapsulated_key** | **String** | Base64-encoded KEM-encapsulated key | [optional] |
|
|
10
|
+
| **algorithm** | **String** | | [optional] |
|
|
11
|
+
| **keypair_id** | **String** | | [optional] |
|
|
12
|
+
| **ephemeral_storage** | [**EncryptData200ResponseDataEphemeralStorage**](EncryptData200ResponseDataEphemeralStorage.md) | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'qsafe-sdk'
|
|
18
|
+
|
|
19
|
+
instance = QSafe::EncryptData200ResponseData.new(
|
|
20
|
+
operation_id: null,
|
|
21
|
+
ciphertext: null,
|
|
22
|
+
encapsulated_key: null,
|
|
23
|
+
algorithm: KYBER768,
|
|
24
|
+
keypair_id: null,
|
|
25
|
+
ephemeral_storage: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QSafe::EncryptData200ResponseDataEphemeralStorage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ephemeral_id** | **String** | Use this ID in the decrypt request instead of raw ciphertext | [optional] |
|
|
8
|
+
| **expires_in** | **Integer** | Seconds until the ephemeral data expires | [optional] |
|
|
9
|
+
| **expires_at** | **Time** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'qsafe-sdk'
|
|
15
|
+
|
|
16
|
+
instance = QSafe::EncryptData200ResponseDataEphemeralStorage.new(
|
|
17
|
+
ephemeral_id: null,
|
|
18
|
+
expires_in: null,
|
|
19
|
+
expires_at: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|