Product Documentation

Rotate HMACs


The Rotate HMACs job will rotate the HMAC key on any record that uses a HMAC hash older than a year or more. For example, if the job runs in July 11, 2026, any token that was encrypted on or before July 11, 2025 will be re-encrypted. Which is why it is recommended to either schedule this job to run fairly soon at the start of the new year, or if there is too many tokens being generated daily so it can keep up. Since these jobs run in the background while SAKA is still working, is best to schedule them when at the most convenient times. This scheduled job will continue to run automatically until the user decides to stop the job, in contrast to the Rotate HMACs Range which stops after all the HMACs on the tokens selected are rotated. The steps to schedule this job are as follows:

  1. First, there needs to update the configuration variables to make available the job. This can be done by selecting "Configuration" -> "View Mutable Configuration" at the top, or selecting the tools icon in the hotbar. 


  2. Set the variables in the correct way for the job to run. There are two mutable configurations (number 74 and 75):
    1. Reportprefix - The prefix to be used to name the reports (logs) generated by SAKA when running the job.
    2. Run - A boolean variable which sets whether the job can be run or not. Can be set to 'true' or 'false'. (It is set to true by default)


  3. After variables are correctly set, head into the Jobs tab by selecting the clock on the hotbar.


  4. By clicking the Rotate HMACs job and then the button for Scheduling on the bar at the right, the dialog will appear. For this job only two options will be available.


    1. Schedule first execution - This will set how many minutes to wait, from scheduling time, before the first execution of the job is ran.
    2. Execute schedule - Determines the time to wait after first execution to run the job again.
       
  5. Select Save at the bottom of the dialog to schedule the rotate HMACs job.

 

Rotate HMACs Range

 There is an option to do the Rotate HMAC job with a range of records instead of all the records that might be due for rotation. As it was mentioned previously, this job will stop after all tokens selected on the range have their HMAC rotated.The steps to schedule this job are the same as with the Rotating HMAC that was explained above, but for the scheduling there will be more options available than there were before.

 

  1. Set the scheduling details on DACTool.


    1. Schedule first execution - This will set how many minutes to wait, from scheduling time, before the first execution of the job is ran.
    2. Execute schedule - Determines the time to wait after first execution to run the job again.
    3. Maximum Jobs to schedule - The amount of jobs to schedule to divide the workload of tokens. Example if there are 50 tokens selected, and this field is set at 5. Then there will be 5 jobs created, each one rotating 10 tokens of the ones selected, until every HMAC for those records are rotated.
    4. Range to Rotate (Min) - The minimum token from where the rotating will start. (Default will be the lowest token found on record)
    5. Range to Rotate (Max) - The maximum token from where the rotating will end. (Default will be the highest token found on record)

  2. Select Save to go see the preview of the jobs to be scheduled.

  3. Select Yes to successfully schedule the Rotate HMACs Range job/s.