The Ubiq Security Ruby Client Library provides convenient interaction with the Ubiq Security Platform API from applications written in the Ruby language. It includes a pre-defined set of classes that will provide simple interfaces to encrypt and decrypt data.
To install using Bundler, add the following to your project's Gemfile:
To manually install ubiq-security Client Library via Rubygems, simply use gem to install it:
gem install ubiq-security
To build and install directly from a clone of the Gitlab directory:
git clone https://gitlab.com/ubiqsecurity/ubiq-ruby.git cd ubiq-ruby bundle install gem build ubiq-security.gemspec gem install ./ubiq-security*.gem
You may need to run the gem install commands above using sudo.
The Client Library needs to be configured with your API Key Credentials which are available in the Ubiq Dashboard How to Use API Key Credentials. The credentials can be explicitly set, set using environment variables, loaded from an explicit file or read from the default location [~/.ubiq/credentials].
require 'ubiq-security' include Ubiq
credentials = ConfigCredentials.new( "some-credential-file", "some-profile").get_attributes
credentials = ConfigCredentials.new().get_attributes
credentials = Credentials()
credentials = Credentials(access_key_id = "...", secret_signing_key = "...", secret_crypto_access_key = "...")
Unsuccessful requests raise exceptions. The class of the exception will reflect the sort of error that occurred. Please see the API Reference for a description of the error classes you should handle, and for information on how to inspect these errors.
Pass credentials and data into the encryption function. The encrypted data will be returned:
require 'ubiq-security' include Ubiq encrypted_data = encrypt(credentials, plaintext_data)
Pass credentials and encrypted data into the decryption function. The plaintext data will be returned:
require 'ubiq-security' include Ubiq plaintext_data = decrypt(credentials, encrypted_data)
- Create an encryption object using the credentials.
- Call the encryption instance begin method
- Call the encryption instance update method repeatedly until all the data is processed
- Call the encryption instance end method
- Call the encryption instance close method
require 'ubiq-security' include Ubiq # Process 1 MiB of plaintext data at a time BLOCK_SIZE = 1024 * 1024 # Rest of the program .... encryption = Encryption.new(credentials, 1) # Write out the header information encrypted_data = encryption.begin() # Loop until the end of the input file is reached until infile.eof? chunk = infile.read BLOCK_SIZE encrypted_data += encryption.update(chunk) end # Make sure any additional encrypted data is retrieved from encryption instance encrypted_data += encryption.end() # Make sure to release any resources used during the encryption process encryption.close()
- Create an instance of the decryption object using the credentials.
- Call the decryption instance begin method
- Call the decryption instance update method repeatedly until all the data is processed
- Call the decryption instance end method
- Call the decryption instance close method
require 'ubiq-security' include Ubiq # Process 1 MiB of encrypted data at a time BLOCK_SIZE = 1024 * 1024 # Rest of the program .... decryption = Decryption(credentials) # Start the decryption and get any header information plaintext_data = decryption.begin() # Loop until the end of the input file is reached until infile.eof? chunk = infile.read BLOCK_SIZE plaintext_data += decryption.update(chunk) end # Make sure an additional plaintext data is retrieved from decryption instance plaintext_data += decryption.end() # Make sure to release any resources used during the decryption process decryption.close()
Updated 6 months ago