topic Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates in API / CLI Discussion

Need To Perform Mass Modification Of All User Accounts Expiration Dates

Daniel_Taney — Mon, 02 Dec 2019 14:15:52 GMT

It came to my attention today that I have a large number of user accounts expiring on 1/1/2020. Given the number, it would be best to update these en masse. I have seen a couple other posts where some folks were accomplishing this using a series of API requests / changes. However, I also came across this older sk article: sk522

Can anyone comment whether this is still a valid method on an R80.30 SMS? I'm not opposed to going the API route if necessary, but this method seems to accomplish the same thing in a single command.

Thanks!

Dan

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

G_W_Albrecht — Mon, 02 Dec 2019 14:23:42 GMT

R80.30 SMS does know nothing about this commend and tells us:

Usage:

fwm ver [-f] ... # Display version

fwm load [opts] [filter-file|rule-base] targets # Install Policy on targets

fwm dbload [targets] # Download the database

fwm logexport [-h] ... # Export log to ascii file

fwm ikecrypt <key> <password> # Crypt a secret with a key

# (for the dbexport command)

fwm kill [-sig_no] procname # Kill firewall process

fwm getpcap ... # Fetch packet capture from gateway

I have added a feedback to sk522 and asked for versions R80.xx...

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

Daniel_Taney — Mon, 02 Dec 2019 14:30:47 GMT

Good catch! I didn't notice that it wasn't listed in the syntax options for fwm.

Perhaps this is why other members were coming up with API-based solutions. Which I'm opposed to if that is truly the only, or best, way!

Thanks!

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

Daniel_Taney — Mon, 02 Dec 2019 15:08:16 GMT

This is also interesting, it looks like you should be able to do this via dbedit, but it returns "failed to get field expiration_date" when attempting to modify it...

Is there something dumb I'm just not seeing here? 😫

Edit: Does this have something to do with expiration_date being under the admin_expiration_base_data opened object?

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

G_W_Albrecht — Mon, 02 Dec 2019 15:51:37 GMT

Easy explanation (see skI3301 How to use the dbedit utility):

In R7x, dbedit could be used for manipulating all object stored in objects_5_0.C and in other fwset files.

In R80.x, the tool is still supported, but it can manipulate only some of the objects (gateways and global properties for instance), while other objects (such as rulebase) can be managed only by the new mgmt_cli tool.

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

masher — Mon, 02 Dec 2019 15:52:04 GMT

This can be done using the API using the set administrator command. It will have to be performed against the "System Data" domain.

[mgmt01]# mgmt_cli -d "System Data" -u admin login > session.id
[mgmt01]# mgmt_cli -s session.id show administrators details-level full -f json | jq -r '.objects[]|[.name,."expiration-date"."iso-8601"]|@csv' > users.csv

On my test system, this responds with the following content:

"admin","2030-12-31T00:00-0500"
"cam","2020-01-01T00:00-0500"
"pam","2020-01-01T00:00-0500"
"sam","2020-01-01T00:00-0500"

The CSV file can then be edited to change the expiration dates of the users that expire on 2020-01-01. I have also added the header row of "name, expiration-date" in order to use it in batch mode.

name,expiration-date
"pam","2021-01-01T00:00-0500"
"sam","2021-01-01T00:00-0500"

Running the command and then verifying the changes

[mgmt01]# mgmt_cli -s session.id -b users.csv set administrator
[mgmt01]# mgmt_cli -s session.id show administrators details-level full -f json | jq -r '.objects[]|[.name,."expiration-date"."iso-8601"]|@csv' > changes.csv

[mgmt01]# more changes.csv 
"admin","2030-12-31T00:00-0500"
"cam","2020-01-01T00:00-0500"
"pam","2021-01-01T00:00-0500"
"sam","2021-01-01T00:00-0500"

Don't forget to publish and logout of your API session when complete.

[mgmt01]# mgmt_cli -s session.id publish 
---------------------------------------------
Time: [05:47:48] 2/12/2019
---------------------------------------------
"Publish operation" succeeded (100%) 
... <snipped>

[mgmt01]# mgmt_cli -s session.id logout
message: "OK"

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

Daniel_Taney — Mon, 02 Dec 2019 16:02:20 GMT

Thank you for this!! This seems like the best course to take since dbedit doesn't appear to support those fields anymore.

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

G_W_Albrecht — Mon, 02 Dec 2019 16:34:20 GMT

Would be nice if we could find this in SK - an equivalent of sk522 How to perform a mass modification to all user accounts' expiration dates for R80.xx...

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

Daniel_Taney — Mon, 02 Dec 2019 17:19:29 GMT

I have a followup question as I just ran this command in my test environment. It looks like this query is only returning Check Point Administrator accounts. I apologize if I wasn't clear from the beginning, these are users defined as RADIUS users for Client Authentication purposes.

I'm assuming this output is because we are querying administrators by using "show administrators". Is there an equivalent query to see non-Administrator users?

This would be users appearing under Users -> Users in the Object Explorer, for example:

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

masher — Mon, 02 Dec 2019 18:58:31 GMT

So that's my misunderstanding. Your subject clearly states "All User Accounts" and has nothing to do with Administrators. 😲

There does not appear to easily display and edit the users list via the mgmt_cli command. You can export the list of users via Object Explorer in SmartConsole to review their expiration dates. If you have that information, it is possible to track down the UIDs of each user (manually) and use the generic-object API to manipulate the expiration date. This is how I handled it in my test environment.

Since this uses the generic-object API, please proceed with caution.

I created a user "usertest" in Smartconsole. Using the show object with a filter for the username as well as a select filter in JQ, I was able to retrieve the UID for the usertest user object.

[mgmt01]# mgmt_cli -s session.id show objects filter usertest -f json details-level full | jq '.objects[]|select(.type=="CpmiUser")|[.name,.uid,.expirationDate]|@csv' 

"\"usertest\",\"75bbb024-de6b-46b1-934f-cea899f7a285\",\"01-Jan-2020\""

Once the UID has been found, the adminExpirationBaseData.expirationDate setting can be adjusted to the new date.

(For full details on the object, use "mgmt_cli show generic-object uid <UID> details-level full"

[mgmt01]# mgmt_cli -r true set generic-object uid 75bbb024-de6b-46b1-934f-cea899f7a285 adminExpirationBaseData.expirationDate "01-Jan-2021"

---------------------------------------------
Time: [13:46:17] 2/12/2019
---------------------------------------------
"Publish operation" succeeded (100%)

WARNING: If you mess-up the date field on the user, it will not be properly set. Using a numeric date does not appear to work and will leave the expiration missing.

Results

[mgmt01]# mgmt_cli -s session.id show objects filter usertest -f json details-level full | jq '.objects[]|select(.type=="CpmiUser")|[.name,.uid,.expirationDate]|@csv'

"\"usertest\",\"75bbb024-de6b-46b1-934f-cea899f7a285\",\"01-Jan-2021\""

Keep in mind that use of the generic-object API is not recommended as it's quite possible to quickly mess things up.

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

Daniel_Taney — Mon, 02 Dec 2019 20:38:11 GMT

That's strange, using your example, I can't seem to find any of these objects in our DB:

mgmt_cli -s session.id show objects filter Test1 -f json details-level full
{
"total" : 0,
"objects" : [ ]
}

mgmt_cli -s session.id show objects filter fwauth -f json details-level full
{
"total" : 0,
"objects" : [ ]
}

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

masher — Mon, 02 Dec 2019 22:50:28 GMT

Is it possible that your session expired?

Does the management return any values if you just do a "show objects"?

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

Daniel_Taney — Tue, 03 Dec 2019 14:58:41 GMT

Yes, I see a dump of database objects. However, if I grep for one of the usernames, I do not see it.

Re: Need To Perform Mass Modification Of All User Accounts Expiration Dates

G_W_Albrecht — Mon, 09 Dec 2019 08:48:50 GMT

I have an answer concerning SecureKnowledge solution sk522

Your feedback was:

------------------

What about the R80.xx versions ?

------------------

This article is not relevant for R80.x

Thank you,

Stella Shteinbuk and the SecureKnowledge Team