Alcatraz::Client

A client library for the Alcatraz PCI-compliant data store.

Installation

Add this line to your application's Gemfile:

gem 'alcatraz-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install alcatraz-client

Usage

You will need your Alcatraz API keys (both public and secret) to use alcatraz-client.

First, set up your connection.

conn = Alcatraz::Client::Connection.new(public_key: ENV['ALCATRAZ_PUBLIC_KEY'], secret_key: ENV['ALCATRAZ_SECRET_KEY'])

After that you can use any of the public API methods for Alcatraz.

Store credit card data

The first thing you'll want to do with Alcatraz is store credit card data securely. That's the whole game after all!

card = conn.store_card!(
  name: 'Jane Doe',
  number: '4111111111111111',
  expiration_month: '5',
  expiration_year: '2015',
  cvv: '123',
  postal_code: '94107',
  country_code: 'US'
)
card.href # => '/cards/afbfe408-8e66-4e11-aecb-e21825512b16'
card.number # => '411111******1111'

The Alcatraz API does not technically require any sort of authentication to store data but in the case of this client, we provide it. Only masked data will be returned from a call to store_card!.

If the card is created successfully it will automatically be authorized to your client.

Fetch credit card data

You can pull card data back out of Alcatraz. Depending on your client's level of access, this data may or may not be masked.

card = conn.get_card('afbfe408-8e66-4e11-aecb-e21825512b16')
# If your client had decryption access...
card.number # => '4111111111111111'
# otherwise...
card.number # => '411111******1111'

Store arbitrary secure data

Alcatraz also allows for the storage of arbitrary "secure" data such as social security numbers, passport numbers, etc.

The API to store arbitrary data is almost identical as storing credit card data.

data = conn.store_data!(
  ssn: '123456789'
)
data.href # => '/secure_data/3a5ca937-7a08-434b-8648-4c34986bfb54'
data.ssn # => '*********'

You'll notice that for arbitrary data, Alcatraz does not do any special processing like it does with credit cards because we do not know what you are sending in. For masked data, the values sent in are fully masked instead of partially masked.

Fetch secure data

Fetching secure data is the same as fetching card data. Again, depending on your access level, the data may or may not be masked.

data = conn.get_data('3a5ca937-7a08-434b-8648-4c34986bfb54')
# With decryption enabled...
data.ssn # => '123456789'
# otherwise...
data.ssn # => '*********'

Create additional API clients

Allows for creation of additional API clients for use with Alcatraz. Your authenticated client must have appropriate authority to use this endpoint. The newly created client will only return its public key.

client = conn.create_client!(name: 'Some Name')
client.inspect # => { id: '3a5ca937-7a08-434b-8648-4c34986bfb54', name: 'Some Name', href: 'api_clients/3a5ca937-7a08-434b-8648-4c34986bfb54', public_key: '3a5ca937-7a08-434b-8648-4c34986bfb54'}

Authorize/Deauthorize data to clients

Allows you to control which of your clients have access to data using their API keys. Used to "claim" data that has been stored in Alcatraz previously. If you store data using the API calls above you will automatically be authorized to it. This method is only to authorize other API clients to access the data with their public/secret key pairs.

data = conn.get_data('3a5ca937-7a08-434b-8648-4c34986bfb54')
authorize_data_for_client!(data, 'some-other-client-public-key')
# Later, to revoke a client's authority to some data...
deauthorize_data_for_client!(data, 'some-other-client-public-key')

Contributing

Fork it ( http://github.com//alcatraz-client/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request