https://github.com/tankerhq/identity-ruby
Identity management in Ruby for the Tanker SDK
https://github.com/tankerhq/identity-ruby
cryptography encryption privacy ruby sdk security tanker
Last synced: 5 months ago
JSON representation
Identity management in Ruby for the Tanker SDK
- Host: GitHub
- URL: https://github.com/tankerhq/identity-ruby
- Owner: TankerHQ
- License: other
- Created: 2019-04-09T15:44:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-04T09:21:44.000Z (7 months ago)
- Last Synced: 2025-08-09T03:52:21.388Z (5 months ago)
- Topics: cryptography, encryption, privacy, ruby, sdk, security, tanker
- Language: Ruby
- Homepage:
- Size: 241 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/TankerHQ/identity-ruby/actions)
[](https://codecov.io/gh/TankerHQ/identity-ruby)
# Identity SDK
Identity generation in Ruby for the [Tanker SDK](https://docs.tanker.io/latest/).
## Requirements
This gem requires Ruby v2.7 or greater. Older Ruby versions are not supported.
## Installation
This project depends on the [rbnacl](https://github.com/crypto-rb/rbnacl) gem, which requires the [libsodium](https://download.libsodium.org/doc/) cryptographic library.
Before going further, please follow [instructions to install libsodium](https://github.com/crypto-rb/rbnacl/wiki/Installing-libsodium).
Then, add this line to your application's Gemfile:
```ruby
gem 'tanker-identity', 'X.Y.Z'
```
Finally, run:
```shell
bundle
```
## API
```ruby
Tanker::Identity.create_identity(app_id, app_secret, user_id)
```
Create a new Tanker identity. This identity is secret and must only be given to a user who has been authenticated by your application. This identity is used by the Tanker client SDK to open a Tanker session.
**app_id**
The app ID, must match the one used in the constructor of the Core SDK.
**app_secret**
The app secret, secret that you have saved right after the creation of your app.
**user_id**
The unique ID of a user in your application.
```ruby
Tanker::Identity.create_provisional_identity(app_id, 'email', email)
```
Create a Tanker provisional identity. It allows you to share a resource with a user who does not have an account in your application yet.
**app_id**
The app ID, must match the one used in the constructor of the Core SDK.
**email**
The email of the potential recipient of the resource.
```ruby
Tanker::Identity.get_public_identity(identity)
```
Return the public identity from an identity. This public identity can be used by the Tanker client SDK to share encrypted resource.
**identity**
A secret identity.
## Usage example
The server-side pseudo-code below demonstrates a typical flow to safely deliver identities to your users:
```ruby
require 'tanker-identity'
# 1. store these configurations in a safe place
app_id = ''
app_secret = ''
# 2. you will typically have methods to check user authentication
def authenticated? # check user is authenticated on the server
def current_user # current authenticated user
# 3. you will need to add internal methods to store / load identities
def db_store_identity(user_id, identity)
def db_load_identity(user_id)
# 4. finally, add user facing functionality
def tanker_secret_identity(user_id)
raise 'Not authenticated' unless authenticated?
raise 'Not authorized' unless current_user.id == user_id
identity = db_load_identity(user_id)
if identity.nil?
identity = Tanker::Identity.create_identity(app_id, app_secret, user_id)
db_store_identity(user_id, identity)
end
identity
end
def tanker_public_identity(user_id)
raise 'Not authenticated' unless authenticated?
identity = db_load_identity(user_id)
raise 'User does not exist or has no identity yet' unless identity
Tanker::Identity.get_public_identity(identity)
end
```
Read more about identities in the [Tanker documentation](https://docs.tanker.io/latest/).
Check the [examples](https://github.com/TankerHQ/identity-ruby/tree/master/examples/) folder for usage examples.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
To audit the Gemfile.lock against the [advisory database](https://rubysec.com/), run `bundle exec bundle-audit check --update`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/TankerHQ/identity-ruby.
[build-badge]: https://travis-ci.org/TankerHQ/identity-ruby.svg?branch=master
[build]: https://travis-ci.org/TankerHQ/identity-ruby