robotframework-crypto 0.2.2

Suppressing encrypted Text from Logs

All Data that is decrypted by CryptoLibrary is replaced in the log by *** This works always and can not be disabled. No need to use special keywords for this.

Usage in Test

*** Settings ***
Resource    imports.resource
Library     CryptoLibrary    %{private_key_password}    variable_decryption=False
#private key which should be secret, should also be protected by a password

*** Variables ***
${secret}=     KILL ALL HUMANS!!!
${enc_user}=   crypt:nkpEPOVKfOko3t04XxOupA+F/ANTEuR9aQuPaPeMBGBQenwYf6UNESEl9MWRKGuj60ZWd10=
${enc_pwd}=    crypt:TVpamLXCtrzRsl8UAgD0YuoY+lSJNV73+bTYhOP51zM1GQihgyCvSZ2CoGoKsUHLFjokyJLHxFzPEB4=

*** Test Cases ***
Valid Login
    Open Browser    ${BASE-URL}
    Suppress Logging                                  #disable Robot Framework logging
    ${var}=    set Variable   ${secret}
    Log    ${var}
    Unsuppress Logging                                #enable Robot Framework logging
    ${user}=    Get Decrypted Text    ${enc_user}     #decrypts cipher text and returns plain text
    Input Text      id:input_username    ${user}
    ${password}=    Get Decrypted Text    ${enc_pwd}  #decrypts cipher text and returns plain text
    Input Password    id:input_password    ${password}
    Click Button    id:button_login
    Page Should Contain Element    //a[text()='Logout']
    [Teardown]   Close Browser

in this case the decryption password for the private key. It can also be saved on test env persistently as a hash.

The parameter variable_decryption in the Library call, if set to true it will automatically decode ALL passwords defined in the variables section and then "Get Decrypted Text" isn’t needed.

CryptoLibrary Command Line Tool

This Command Line tool has to be used to create a key pair. It can also show the public key and encrypt or decrypt data.

python -m CryptoLibrary:

? What do you want to do?  (Use arrow keys)
  Encrypt
  Decrypt
  Open config --->  ? What do you want to do?  (Use arrow keys)
  Quit                 Configure key pair    ----------------------------------------------------------------------------------------->  ? What do you want to do?  (Use arrow keys)
                       Configure public key  --->  ? What do you want to do?  (Use arrow keys)                                             Generate key pair
                       Back                          Set public key from string  --->   ? Input public_key as Base64:  ThePublicKey        Set key pair from file
                                                     Get public key from string  --->   Public Key: ThePublicKey                           Set key pair from string
                                                     Delete public key           --->   ? Do you really want to delete public key?         Delete key pair
                                                     Back                                                                                  Save private key password
                                                                                                                                           Delete saved password
                                                                                                                                           Back
? What do you want to do?  (Use arrow keys)
  Encrypt     ------------------------------------------------------------------->   ? Enter the password to encrypt  YourPassword
  Decrypt     -----> ? Input encrypted cipher text:  crypt:TheEncryptedPassword      Encrypted password: (use inlc. "crypt:")
  Open config        ? Enter the password to decrypt  **********
  Quit               Your password is: YourPassword                                  crypt:TheEncryptedPassword=

To start using the CryptoLibrary, start python -m CryptoLibrary and choose Open config -> Configure key pair-> Generate key pair.

This generates the private and public keys in the private_key.json and public_key.key files. The private_key.json is needed to decrypt the values on your test server and has to be copied manually or added through the CLI interface. See Set key pair from... above.

Next you can encrypt the values needed on your test server, looking something like crypt:nkpEPOVKfOko3t04XxOupA+F/ANTEuR9aQuPaPeMBGBQenwYf6UNESEl9MWRKGuj60ZWd10=

There are two options to decrypt your values in the robot file. When CryptoLibrary is loaded with variable_decryption=True, ALL variables defined in that section, will automatically get decrypted. When the option is turned off (the default) the keyword Get Decrypted Text explicitly decrypts specific values.

CryptoClient Command Line Tool

This CryptoClient command line tool is the tool for all test designers that want to encrypt data. I can only import and show the public key and encrypt data.

python -m CryptoClient:

? What do you want to do?  (Use arrow keys)
  Encrypt     --------------------------------------------------------------------------------------->   ? Enter the password to encrypt  YourPassword
  Open config -----> ? What do you want to do?  (Use arrow keys)                                           Encrypted password: (use inlc. "crypt:")
  Quit                 Set public key from string  --->   ? Input public_key as Base64:  ThePublicKey
                       Get public key from string  --->   Public Key: ThePublicKey                         crypt:TheEncryptedPassword
                       Delete public key           --->   ? Do you really want to delete public key?
                       Back