Home

NAME

virgil -- command line tool for using Virgil Security full stack functionality.

SYNOPSIS

virgil command [command_opts] [command_args]

DESCRIPTION

The Virgil program is a command line tool for using Virgil Security stack functionality:

• encrypt, decrypt, sign and verify data;
• interact with Virgil Keys Service;
• interact with Virgil Private Keys Service.

COMMON COMMANDS

keygen
Generate a Private Key with given parameters.

key2pub
Extract a Public Key from the Private Key.

encrypt Encrypt data for given recipients which can be defined by the Virgil Keys and by passwords.

decrypt
Decrypt data for given recipient which can be defined by the Virgil Public Key or by password.

sign
Sign data with the Private Key.

verify
Verify data and signature with the Public Key.

hash
Derives the obfuscated data from the incoming parameters using PBKDF function.

IDENTITY SERVICE COMMANDS

identity-confirm-global
Confirmation of the Identity. Returns the validation_token which is required for the operations with Cards and the confirmed identity:

1. card-create-global(1);
2. card-revoke-global(1);
3. `public-key-revoke(1).

identity-confirm-private
Confirmation of the Identity. Returns the validation_token which is required for the operations with the Cards and the confirmed identity:

1. card-create-private(1);
2. card-revoke-private(1);
3. `public-key-revoke(1).

identity-verify
Verifies the identity. Returns action_id.

identity-validate
Validates the passed token. Checks whether validation_token is valid. It has time and usage limits.

KEYS SERVICE COMMANDS

public-key-get
Get user's Virgil Public Key from the Virgil Keys Service.

public-key-revoke
Revoke the Public Key’s data. Within one-to-many model we can have the Cards with a single Public Key and connected with public-key-id. Instead of deleting every Card one at a time we can delete all the Cards connected with the Public Key ID.

VIRGIL CARD SERVICE COMMANDS

card-create-global
Create a Global Virgil Card. Creates a Global Virgil Card. This means identity-verify; identity-confirm-global.

card-create-private
Create a Private Virgil Card. Creates a Private Virgil Card. This means identity-confirm-private.

card-search-global
Search the Card by the email or the application name.

card-search-private
Search the Card by the email. Search criteria:

1. Include the Cards with an unconfirmed Identity;
2. Search for the Cards which have signed some other Cards.

card-get
Get user's Virgil Card from the Virgil Keys Service.

card-revoke-private
Revoke the Private Virgil Card by the card-id.

card-revoke-global
Revoke the Global Virgil Card by the card-id.

PRIVATE KEYS SERVICE COMMANDS

private-key-add
Add an existing Private Key to the Private Keys Service.

private-key-get
Get the Private Key from the Virgil Private Keys Service.

private-key-del
Delete the Private Key object from the Private Keys Service.

SEE ALSO

keygen(1)
key2pub(1)
encrypt(1)
decrypt(1)
sign(1)
verify(1)
hash(1)
identity-verify(1)
identity-confirm-global(1)
identity-confirm-private(1)
identity-valid(1)
public-key-get(1)
public-key-revoke(1)
card-create-global(1)
card-create-private(1)
card-search-global(1)
card-search-private(1)
card-get(1)
card-revoke-private(1)
card-revoke-global(1)
private-key-add(1)
private-key-get(1)
private-key-del(1)