virgil identity confirm private.1 - VirgilSecurity/virgil-cli GitHub Wiki

NAME

identity-confirm-private -- generate validation token based on application's private key.

SYNOPSIS

    virgil identity-confirm-private  [-o <file>] -d <arg> -t <arg> --app-key <file>
                             [--app-key-password <arg>] [-V] [--]
                             [--version] [-h]

DESCRIPTION

Provides helper methods to generate validation token based on application's private key. It is required for the following operations:

  1. Create a Private Virgil Card with a confirmed Identity. See 'virgil-card-create-private(1)';
  2. Revoke a Private Virgil Card, a group of Cards. See virgil-card-revoke-private(1), virgil-public-key-revoke-private(1);
  3. Get a private key from the Private Keys Service. See virgil-private-key-get(1).

OPTIONS

    -o <file>,  --validation-token <file>
     A Validation-token. If omitted, stdout is used.

    -d <arg>,  --identity <arg>
     (required)  Identity value

    -t <arg>,  --identity-type <arg>
     (required)  Identity type

    --app-key <file>
     (required)  Application Private key

    --app-key-password <arg>
     Password to be used for Application Private Key encryption.

    -V,  --VERBOSE
     Shows detailed information.

    --,  --ignore_rest
     Ignores the rest of the labeled arguments following this flag.

    --version
     Displays version information and exits.

    -h,  --help
     Displays usage information and exits.

RETURN VALUE

On success, validated identity model:

  1. Not obfuscated identity value and identity type

    -d, --identity = "[email protected]"
    -t, --identity-type = "email"
    
    {
        "type": "email",
        "value": "[email protected]",
        "validation_token": *validation_token*
    }
    
  2. Obfuscated identity ( see virgil-exhash(1) ) value and identity type

    -d, --identity = "xSf79dt6Bl6/WwHmO/KrIlaWrUxX2GLV7l7Jo+SCZSqT48Cq6mMWNDTkUPeMp82r"
    -t, --identity-type = "WHTbiO4KeZUYC4tm5DWVJfacwdlmLkJZnhJKbMCFAdjC0hSkdHs3EnIWlPt+Lnni"
    
    {
        "type": "WHTbiO4KeZUYC4tm5DWVJfacwdlmLkJZnhJKbMCFAdjC0hSkdHs3EnIWlPt+Lnni",
        "value": "xSf79dt6Bl6/WwHmO/KrIlaWrUxX2GLV7l7Jo+SCZSqT48Cq6mMWNDTkUPeMp82r",
        "validation_token": *validation_token*
    }
    

is returned. On error, exception is thrown.

EXAMPLES

  1. Generate a validation token:

    virgil identity-confirm-private -d [email protected] -t email -o validated-identity-private.txt --app-key application-private.key
    
  2. Generate validation-token with obfuscated identity:

    virgil identity-confirm-private -d <obfuscated_value> -t <obfuscated_type> -o validated-identity-private.txt --app-key application-private.key
    

SEE ALSO

virgil(1) virgil-config(1) virgil-card-create-private(1) virgil-card-revoke-private(1) virgil-private-key-get(1)

⚠️ **GitHub.com Fallback** ⚠️