HomeGuidesAPI ReferenceChangelogDiscussions
Log In

Encrypt/Decrypt

Suggest Edits

Encrypt/Decrypt CLI

This CLI module will allow you to encrypt and decrypt .csv, .json, .txt, or .yaml files with a passkey.

  • encrypt - Encrypt a .csv, .json, .txt, or .yaml file with a passkey
    • --file - the file you would like to encrypt
  • decrypt - Decrypt a .csv, .json, .txt, or .yaml file with a passkey
    • --file - the file you would like to decrypt
  • change_passkey - Change your encryption/decryption passkey

The purpose of this CLI command is to provide the ability to encrypt sensitive files used by the CLI so no passwords, keys, or other security significant information is stored in clear text. The CLI command is most commonly used to provide encryption for the init.yaml file which contains secrets which are used to orchestrate the CLI. The encryption prevents the keys from being stolen should anyone gain access to the server/container where the CLI is running. It is highly recommended that all secret files leverage the CLI encryption to protect sensitive data.

Example Commands

You can set up your passkey with your first ever encrypt command, or use the change-passkey command.

  • regscale change_passkey

Encrypt your init.yaml file.

  • regscale encrypt --file init.yaml

Decrypt queries.csv file in the data directory.

  • regscale decrypt --file data/queries.csv

Encrypted init.yaml Example

The following init.yaml shows you a before and after being encrypted:

Before

domain: https://mycompany.regscale.com
token: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImN0eSI6IkpXVCJ9.eyJzdWIiOiJhYmVsYXJkbyJ9
maxThreads: 1000
userId: e8c8aa2e-c66f-49fb-a373-00c89b45c90d

After

gAAAAABjdplaamGSjuT_zu-rlPG8jX3nvSteJ4t4eN9a1TLxYNB4JIc7NipLZGY2Yq1qzXqt-lYITmhDJdwEP4ipDVs-GkGwSQqOdBJOBMNxrovDcyl3ipSIuIBTaAShp6qIEPnJq03A7scsk7ewXdm-uqQG7CfqNKXrqJGw3CrmtTWji_cwq2Q-tH4GeUp6gtTB8vT66IZQZEHONsIivDoWH92WZ_f_YhGprRJEo1EyyfYG6P44xu35AE8UohKUe5LjSkBeb2AmbbnjtBNqvxrrdXVndC9Bum8R1sImrQuLsNxfHTj5PY76RI4h_PGxsK9F6_JeeO_qSqvJOwwEc8mb-lE4qgyEQnSjlHzVxA7TptB7mNZ8RDci-kiy3VaJJQkFxrA5W7TvD5vjA3C1fbrCyw0YDeCbwmkBnZBOSg66CcYCA8UA8m05hIZjktiNJkB0r_ssXHOW1VtUt8C-Pl_DyC15hDRmkrSz3SFZCbu4CjNqfTZf3IB7H7nRT7H_9tFSJzDSWHhwHML9VKL-XyEwCW2oCkaabRtRKxVBbtgRi-NS5ZRwZ5qlZXeZuwFnxNyTAGEsYpoERk1CWr6qthxPqhgoja54SlThGBCIQ7E_QPLg7NS0gkxsAE3OYEaUSVjSJqE5j8fIoyJDzwcHkkEOAB6L53ak2xTdSn0yJATljnliBjsxv-_Q1jYbEcAc7-JleHVRPpzDLXQhTnH_hcFv1oVjD1y1svGHLVVLKo-Q30LX72zzjWgvvr5x1GAdm-cLYZbNfOvwMiRzUvNSApp4QS5dy_3MjII7KyPOdgcndmANGWctY1yNGTIaq_e_7f8-N6HX4DxY3I2cVpnq12wgn1atWz2BPHrwE2y-ETGH2i2H8fE0Rn-cjbn2Lg-_lR2VGXTCBC_9Q1lB6yFBeSnBVk5lQ51T0iq2xuBzZHHeGUbPPszqEQeOChrnKfu-3IHNq7mEhT5wezsAIx4NJopO6tF9ddvu4_h6YwpQN86WCI3lkshEpIHiDj9rHrbt36zZJzrjNhgByBsdwuUnUCxvVFPphWLGUAqgh58V5oYSSaQxrnUR4fS3XEuviuzqtu76Cm9q_HMg8VaJQOBuzgo4Ge-6KXi_bCbp22dC6ojRyVMRLnWaPaTciEjZGdHG0vRpq1jb3GCLcjP08HYlbcwB_zj2h8bhdMiW24-upgyAVmL2ec-wiwc4tevh1hK5ADr3GXfUuOTjo34JHQiEXyWKJ22vwB-MfXkBMpWSArHfTqBIk1CxfHTeMG7TPUXZJZX_yWaOh_GVTL56706s2cv3cE6BJWhNNxVi-2I_q6qUMiFVfmP8hyDlBtPlyWN7Nvy1hYdCccyeyFvbwAk1OnsCs6v-fQZahoBbtPNRll-vRpjqXvo6t2_41azvQvIXK23O3hp6mo3NOeHivBClFSSYVZFkVH2MT_5ZwHEnf5j5BvPPvBMPCZHMqOwj62lT6ADZcPtXhgWf7iMV30foBROHxlbfClu6SchSF4P_PenoX-oZlXn-ZBE6urQRG-siNq1BUwy6gBXqVh9sMGY5eLgUxUdJxpQGlYKxW2smCkH_QdBdtzJz4japaU9xO0Lo35gpXbhui8auQSRE9DSa8ZiZFH2rMe0Gppl44UF4sDugKExnNtrruZONFlQVDv939UZuOcUZ3cVRVI3kvYzUxsaKqMGXS5OUSCYUdCAtQgTR7HUkcIzBGgEYEKrK3Rd3wqYBFpscmqUp7jzt4ThjuKyjGiPlinvxDBF3SW0gvdjZaZQgOzyyVUR8mC2JOJeZcKFCsVNDqprMkO4wsiW3z5Ygx2tYMgctlhlOiZ-cKjB5zeZC7lVGaYWi8ZKH_azmeo962IDGk8loq9SezINM6C3dQFCdVMpi5UMUPII9Jp1FUcm2awlGeTEWrRj9w0cpzmYE4bGZqtfqeMU1mC9Bh1HyWR6XKsDKXkcnEiOElzXZw81MpEz5hsduYond8SdWvd1P4h3PLO9uyKCiXEUnvwX1Z1MB0j0o2ORhcSwdvy-W_R0EKrb9fT1SqzN82sqP6Ayi_50HAnAhaBtIOkDbfxQGetKy6TTZBecz48R2g5kf7A5IV6goDPrKixSZy3HUjAUyqzYWirZ-MvX9Qtoau9i8teX1FWyYglGw-P62rXLglrxezaQRn01kqGoth_Ogp98VZJrFJ69vXGHxV3pT3NMRkUwGdbPxisupnLaRhKTfSmD1LoSF0vpiZJSjXFP1jXWBgbHDSQ_GWT-xiw16MlH0QTJ6f2LHyDV-4uG0hx6MoYkP1Aw-D8g=

Updated 5 months ago