mirror of
https://github.com/inspec/inspec
synced 2024-11-15 09:27:20 +00:00
137 lines
3 KiB
Text
137 lines
3 KiB
Text
---
|
|
title: About the users Resource
|
|
platform: os
|
|
---
|
|
|
|
# users
|
|
|
|
Use the `users` InSpec audit resource to look up all local users available on the system, and then test specific properties of those users. This resource does not return information about users that may be located on other systems, such as LDAP or Active Directory.
|
|
|
|
<br>
|
|
|
|
## Availability
|
|
|
|
### Installation
|
|
|
|
This resource is distributed along with InSpec itself. You can use it automatically.
|
|
|
|
### Version
|
|
|
|
This resource first became available in v1.0.0 of InSpec.
|
|
|
|
## Syntax
|
|
|
|
A `users` resource block declares a user name, and then one (or more) matchers:
|
|
|
|
describe users.where(uid: 0).entries do
|
|
it { should eq ['root'] }
|
|
its('uids') { should eq [1234] }
|
|
its('gids') { should eq [1234] }
|
|
end
|
|
|
|
where
|
|
|
|
* `gid`, `group`, `groups`, `home`, `maxdays`, `mindays`, `shell`, `uid`, and `warndays` are valid matchers for this resource
|
|
* `where(uid: 0).entries` represents a filter that runs the test only against matching users
|
|
|
|
For example:
|
|
|
|
describe users.where { username =~ /.*/ } do
|
|
it { should exist }
|
|
end
|
|
|
|
or:
|
|
|
|
describe users.where { uid =~ /^S-1-5-[0-9-]+-501$/ } do
|
|
it { should exist }
|
|
end
|
|
|
|
<br>
|
|
|
|
## Examples
|
|
|
|
The following examples show how to use this InSpec audit resource.
|
|
|
|
### Use a regular expression to find users
|
|
|
|
describe users.where { uid =~ /S\-1\-5\-21\-\d+\-\d+\-\d+\-500/ } do
|
|
it { should exist }
|
|
end
|
|
|
|
<br>
|
|
|
|
## Matchers
|
|
|
|
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
|
|
|
|
### exist
|
|
|
|
The `exist` matcher tests if the named user exists:
|
|
|
|
it { should exist }
|
|
|
|
### gid
|
|
|
|
The `gid` matcher tests the group identifier:
|
|
|
|
its('gid') { should eq 1234 } }
|
|
|
|
where `1234` represents the user identifier.
|
|
|
|
### group
|
|
|
|
The `group` matcher tests the group to which the user belongs:
|
|
|
|
its('group') { should eq 'root' }
|
|
|
|
where `root` represents the group.
|
|
|
|
### groups
|
|
|
|
The `groups` matcher tests two (or more) groups to which the user belongs:
|
|
|
|
its('groups') { should eq ['root', 'other']}
|
|
|
|
### home
|
|
|
|
The `home` matcher tests the home directory path for the user:
|
|
|
|
its('home') { should eq '/root' }
|
|
|
|
### maxdays
|
|
|
|
The `maxdays` matcher tests the maximum number of days between password changes:
|
|
|
|
its('maxdays') { should eq 99 }
|
|
|
|
where `99` represents the maximum number of days.
|
|
|
|
### mindays
|
|
|
|
The `mindays` matcher tests the minimum number of days between password changes:
|
|
|
|
its('mindays') { should eq 0 }
|
|
|
|
where `0` represents the maximum number of days.
|
|
|
|
### shell
|
|
|
|
The `shell` matcher tests the path to the default shell for the user:
|
|
|
|
its('shells') { should eq ['/bin/bash'] }
|
|
|
|
### uid
|
|
|
|
The `uid` matcher tests the user identifier:
|
|
|
|
its('uid') { should eq 1234 } }
|
|
|
|
where `1234` represents the user identifier.
|
|
|
|
### warndays
|
|
|
|
The `warndays` matcher tests the number of days a user is warned before a password must be changed:
|
|
|
|
its('warndays') { should eq 5 }
|
|
|
|
where `5` represents the number of days a user is warned.
|