Module: QSafe

Defined in:
lib/qsafe/version.rb,
lib/qsafe.rb,
lib/qsafe-sdk.rb,
lib/qsafe/api_error.rb,
lib/qsafe/api_client.rb,
lib/qsafe-sdk/version.rb,
lib/qsafe/models/user.rb,
lib/qsafe/models/error.rb,
lib/qsafe-sdk/api_error.rb,
lib/qsafe/api/debug_api.rb,
lib/qsafe/configuration.rb,
lib/qsafe-sdk/api_client.rb,
lib/qsafe/api/health_api.rb,
lib/qsafe/models/api_key.rb,
lib/qsafe/models/keypair.rb,
lib/qsafe-sdk/models/user.rb,
lib/qsafe-sdk/models/error.rb,
lib/qsafe/api/api_keys_api.rb,
lib/qsafe/api/keypairs_api.rb,
lib/qsafe-sdk/api/debug_api.rb,
lib/qsafe-sdk/configuration.rb,
lib/qsafe/api/utilities_api.rb,
lib/qsafe-sdk/api/health_api.rb,
lib/qsafe-sdk/models/api_key.rb,
lib/qsafe-sdk/models/keypair.rb,
lib/qsafe/models/sign_request.rb,
lib/qsafe-sdk/api/api_keys_api.rb,
lib/qsafe-sdk/api/keypairs_api.rb,
lib/qsafe/models/auth_response.rb,
lib/qsafe/models/login_request.rb,
lib/qsafe-sdk/api/utilities_api.rb,
lib/qsafe/models/verify_request.rb,
lib/qsafe/api/authentication_api.rb,
lib/qsafe/models/decrypt_request.rb,
lib/qsafe/models/encrypt_request.rb,
lib/qsafe-sdk/models/sign_request.rb,
lib/qsafe/models/register_request.rb,
lib/qsafe-sdk/models/auth_response.rb,
lib/qsafe-sdk/models/login_request.rb,
lib/qsafe-sdk/models/verify_request.rb,
lib/qsafe/models/auth_response_data.rb,
lib/qsafe-sdk/api/authentication_api.rb,
lib/qsafe-sdk/models/decrypt_request.rb,
lib/qsafe-sdk/models/encrypt_request.rb,
lib/qsafe-sdk/models/register_request.rb,
lib/qsafe/models/sign_data200_response.rb,
lib/qsafe-sdk/models/auth_response_data.rb,
lib/qsafe/models/create_api_key_request.rb,
lib/qsafe/models/get_health200_response.rb,
lib/qsafe/models/revoke_keypair_request.rb,
lib/qsafe/models/update_api_key_request.rb,
lib/qsafe/models/update_keypair_request.rb,
lib/qsafe/models/change_password_request.rb,
lib/qsafe/models/get_api_key200_response.rb,
lib/qsafe/models/decrypt_data200_response.rb,
lib/qsafe/models/encrypt_data200_response.rb,
lib/qsafe/models/generate_keypair_request.rb,
lib/qsafe-sdk/models/sign_data200_response.rb,
lib/qsafe/api/cryptographic_operations_api.rb,
lib/qsafe/models/get_auth_info200_response.rb,
lib/qsafe/models/list_api_keys200_response.rb,
lib/qsafe/models/list_keypairs200_response.rb,
lib/qsafe-sdk/models/create_api_key_request.rb,
lib/qsafe-sdk/models/get_health200_response.rb,
lib/qsafe-sdk/models/revoke_keypair_request.rb,
lib/qsafe-sdk/models/update_api_key_request.rb,
lib/qsafe-sdk/models/update_keypair_request.rb,
lib/qsafe/models/create_api_key201_response.rb,
lib/qsafe/models/revoke_keypair200_response.rb,
lib/qsafe/models/rotate_api_key200_response.rb,
lib/qsafe/models/sign_data200_response_data.rb,
lib/qsafe/models/update_keypair200_response.rb,
lib/qsafe-sdk/models/change_password_request.rb,
lib/qsafe-sdk/models/get_api_key200_response.rb,
lib/qsafe/models/change_password200_response.rb,
lib/qsafe-sdk/models/decrypt_data200_response.rb,
lib/qsafe-sdk/models/encrypt_data200_response.rb,
lib/qsafe-sdk/models/generate_keypair_request.rb,
lib/qsafe/models/debug_redis_test200_response.rb,
lib/qsafe/models/debug_redis_test500_response.rb,
lib/qsafe/models/generate_keypair201_response.rb,
lib/qsafe/models/verify_signature200_response.rb,
lib/qsafe-sdk/api/cryptographic_operations_api.rb,
lib/qsafe-sdk/models/get_auth_info200_response.rb,
lib/qsafe-sdk/models/list_api_keys200_response.rb,
lib/qsafe-sdk/models/list_keypairs200_response.rb,
lib/qsafe/models/decrypt_data200_response_data.rb,
lib/qsafe/models/encrypt_data200_response_data.rb,
lib/qsafe/models/get_api_key_usage200_response.rb,
lib/qsafe-sdk/models/create_api_key201_response.rb,
lib/qsafe-sdk/models/revoke_keypair200_response.rb,
lib/qsafe-sdk/models/rotate_api_key200_response.rb,
lib/qsafe-sdk/models/sign_data200_response_data.rb,
lib/qsafe-sdk/models/update_keypair200_response.rb,
lib/qsafe/models/get_auth_info200_response_data.rb,
lib/qsafe/models/list_api_keys200_response_data.rb,
lib/qsafe/models/list_keypairs200_response_data.rb,
lib/qsafe/models/sign_request_ephemeral_storage.rb,
lib/qsafe-sdk/models/change_password200_response.rb,
lib/qsafe/models/get_health200_response_services.rb,
lib/qsafe-sdk/models/debug_redis_test200_response.rb,
lib/qsafe-sdk/models/debug_redis_test500_response.rb,
lib/qsafe-sdk/models/generate_keypair201_response.rb,
lib/qsafe-sdk/models/verify_signature200_response.rb,
lib/qsafe/models/decrypt_request_ephemeral_crypto.rb,
lib/qsafe-sdk/models/decrypt_data200_response_data.rb,
lib/qsafe-sdk/models/encrypt_data200_response_data.rb,
lib/qsafe-sdk/models/get_api_key_usage200_response.rb,
lib/qsafe/models/encrypt_request_ephemeral_storage.rb,
lib/qsafe/models/get_rate_limit_status200_response.rb,
lib/qsafe/models/verify_signature200_response_data.rb,
lib/qsafe-sdk/models/get_auth_info200_response_data.rb,
lib/qsafe-sdk/models/list_api_keys200_response_data.rb,
lib/qsafe-sdk/models/list_keypairs200_response_data.rb,
lib/qsafe-sdk/models/sign_request_ephemeral_storage.rb,
lib/qsafe/models/get_api_key_usage200_response_data.rb,
lib/qsafe-sdk/models/get_health200_response_services.rb,
lib/qsafe/models/generate_keypair_request_key_policy.rb,
lib/qsafe/models/get_health200_response_services_api.rb,
lib/qsafe-sdk/models/decrypt_request_ephemeral_crypto.rb,
lib/qsafe-sdk/models/encrypt_request_ephemeral_storage.rb,
lib/qsafe-sdk/models/get_rate_limit_status200_response.rb,
lib/qsafe-sdk/models/verify_signature200_response_data.rb,
lib/qsafe/models/get_health200_response_services_redis.rb,
lib/qsafe-sdk/models/get_api_key_usage200_response_data.rb,
lib/qsafe/models/get_rate_limit_status200_response_data.rb,
lib/qsafe-sdk/models/generate_keypair_request_key_policy.rb,
lib/qsafe-sdk/models/get_health200_response_services_api.rb,
lib/qsafe-sdk/models/get_health200_response_services_redis.rb,
lib/qsafe/models/list_api_keys200_response_data_pagination.rb,
lib/qsafe/models/list_keypairs200_response_data_pagination.rb,
lib/qsafe-sdk/models/get_rate_limit_status200_response_data.rb,
lib/qsafe/models/debug_redis_test200_response_rate_limit_test.rb,
lib/qsafe/models/debug_redis_test200_response_services_status.rb,
lib/qsafe-sdk/models/list_api_keys200_response_data_pagination.rb,
lib/qsafe-sdk/models/list_keypairs200_response_data_pagination.rb,
lib/qsafe/models/get_rate_limit_status200_response_data_limits.rb,
lib/qsafe-sdk/models/debug_redis_test200_response_rate_limit_test.rb,
lib/qsafe-sdk/models/debug_redis_test200_response_services_status.rb,
lib/qsafe-sdk/models/get_rate_limit_status200_response_data_limits.rb,
lib/qsafe/models/get_health200_response_services_ephemeral_storage.rb,
lib/qsafe/models/get_rate_limit_status200_response_data_reset_times.rb,
lib/qsafe/models/get_api_key_usage200_response_data_daily_usage_inner.rb,
lib/qsafe/models/get_rate_limit_status200_response_data_current_usage.rb,
lib/qsafe-sdk/models/get_health200_response_services_ephemeral_storage.rb,
lib/qsafe-sdk/models/get_rate_limit_status200_response_data_reset_times.rb,
lib/qsafe-sdk/models/get_api_key_usage200_response_data_daily_usage_inner.rb,
lib/qsafe-sdk/models/get_rate_limit_status200_response_data_current_usage.rb

Overview

#QSafe PQC API

#Post-quantum cryptography SaaS API supporting ML-KEM (Kyber) and ML-DSA (Dilithium) algorithms. Provides keypair management and cryptographic operations (encrypt, decrypt, sign, verify). ## Authentication - **JWT Bearer Token** — user-based auth, obtained from ‘/auth/login` or `/auth/register` - **API Key (header)** — programmatic access via `X-API-Key` header - **API Key (query)** — programmatic access via `?api_key=` query parameter ## Quick Start 1. Register → `POST /auth/register` 2. Login → `POST /auth/login` → copy `data.token` 3. Generate keypair → `POST /generate-keypair` 4. Encrypt / Sign with the keypair ID

The version of the OpenAPI document: 1.0.0 Contact: rushikesh.n.kakadiya@gmail.com Generated by: openapi-generator.tech Generator version: 7.9.0

Defined Under Namespace

Classes: APIKeysApi, ApiClient, ApiError, ApiKey, AuthResponse, AuthResponseData, AuthenticationApi, ChangePassword200Response, ChangePasswordRequest, Configuration, CreateApiKey201Response, CreateApiKeyRequest, CryptographicOperationsApi, DebugApi, DebugRedisTest200Response, DebugRedisTest200ResponseRateLimitTest, DebugRedisTest200ResponseServicesStatus, DebugRedisTest500Response, DecryptData200Response, DecryptData200ResponseData, DecryptRequest, DecryptRequestEphemeralCrypto, EncryptData200Response, EncryptData200ResponseData, EncryptRequest, EncryptRequestEphemeralStorage, Error, GenerateKeypair201Response, GenerateKeypairRequest, GenerateKeypairRequestKeyPolicy, GetApiKey200Response, GetApiKeyUsage200Response, GetApiKeyUsage200ResponseData, GetApiKeyUsage200ResponseDataDailyUsageInner, GetAuthInfo200Response, GetAuthInfo200ResponseData, GetHealth200Response, GetHealth200ResponseServices, GetHealth200ResponseServicesApi, GetHealth200ResponseServicesEphemeralStorage, GetHealth200ResponseServicesRedis, GetRateLimitStatus200Response, GetRateLimitStatus200ResponseData, GetRateLimitStatus200ResponseDataCurrentUsage, GetRateLimitStatus200ResponseDataLimits, GetRateLimitStatus200ResponseDataResetTimes, HealthApi, Keypair, KeypairsApi, ListApiKeys200Response, ListApiKeys200ResponseData, ListApiKeys200ResponseDataPagination, ListKeypairs200Response, ListKeypairs200ResponseData, ListKeypairs200ResponseDataPagination, LoginRequest, RegisterRequest, RevokeKeypair200Response, RevokeKeypairRequest, RotateApiKey200Response, SignData200Response, SignData200ResponseData, SignRequest, SignRequestEphemeralStorage, UpdateApiKeyRequest, UpdateKeypair200Response, UpdateKeypairRequest, User, UtilitiesApi, VerifyRequest, VerifySignature200Response, VerifySignature200ResponseData

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

QSafe.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



100
101
102
103
104
105
106
 
# File 'lib/qsafe.rb', line 100

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end