Go to main content

man pages section 5: File Formats

Exit Print View

Updated: Thursday, June 13, 2019
 
 

auth_attr(5)

Name

auth_attr - authorization description database

Synopsis

/etc/security/auth_attr 

Description

/etc/security/auth_attr is a local source for authorization names and descriptions. The auth_attr file can be used with other authorization sources, including the auth_attr NIS map. Programs use the getauthattr(3C) routines to access this information.

The search order for multiple authorization sources is specified in the /etc/nsswitch.conf file, as described in the nsswitch.conf(5) man page.

An authorization is a right assigned to users that is checked by certain privileged programs to determine whether users can execute restricted functionality. Each entry in the auth_attr database consists of one line of text containing six fields separated by colons ( :). Line continuations using the backslash (\) character are permitted. The format of each entry is:

name:res1:res2:short_desc:long_desc:attr
name

The name of the authorization. Authorization names are unique strings. Construct authorization names using the following convention:

prefix. or prefix.suffix

prefix

Everything in the name field up to the final dot (.). Authorizations from Oracle Solaris use solaris as a prefix. To avoid name conflicts, all other authorizations should use a prefix that begins with the reverse–order Internet domain name of the organization that creates the authorization (for example, com.xyzcompany). Prefixes can have additional arbitrary components chosen by the authorization's developer, with components separated by dots.

suffix

The final component in the name field. Specifies what is being authorized.

When there is no suffix, the name is defined as a heading. Headings are not assigned to users but are constructed for use by applications in their GUIs.

To assign an authorization, the user needs to have both the authorization itself and the solaris.auth.delegate authorization.

res1

The characters RO in this field indicate it is read only and not modifiable by the tools that update this database.

res2

Reserved for future use.

short_desc

A short description or terse name for the authorization. This name should be suitable for displaying in user interfaces, such as in a scrolling list in a GUI.

long_desc

A long description. This field can explain the precise purpose of the authorization, the applications in which it is used, and the type of user that would be interested in using it. The long description can be displayed in the help text of an application.

attr

An optional list of semicolon-separated (;) key-value pairs that describe the attributes of an authorization. Zero or more keys can be specified.

Examples

Example 1 Constructing a Name

In the following example, the name has a prefix (solaris.admin.usermgr) followed by a suffix (read):

solaris.admin.usermgr.read
Example 2 Defining a Heading

Because the name field ends with a dot, the following entry defines a heading:

solaris.user.:::User Accounts::
Example 3 Assigning Separate Authorizations to Set User Attributes

In this example, a heading entry is followed by other associated authorization entries. The entries below the heading provide separate authorizations for setting user attributes.

solaris.role.:::Role Accounts::
solaris.role.manage:::Manage Role Accounts::
solaris.role.delegate:::Delegate Role Accounts::
Example 4 Assigning a Grant Authorization

This example assigns to an administrator the following authorizations:

solaris.auth.delegate
solaris.user.manage
solaris.role.manage

With the above authorizations, the administrator can assign to others the solaris.user.manage and solaris.role.manage authorizations, but not any other authorization. If the administrator has both the solaris.auth.delegate and the solaris.*.manage authorization, it would be equivalent to the above authorizations. See user_attr(5) for more information about how wildcards can be used to assign multiple authorizations whose names have the same components.

Example 5 Authorizing the Ability to Assign Other Authorizations

The following entry defines an authorization that grants the ability to assign any authorization.

solaris.auth.assign:::Grant All Solaris Authorizations::
Example 6 Consulting the Local Authorization File Ahead of the NIS Table

With the following entry from /etc/nsswitch.conf, the local auth_attr file is consulted before the LDAP name service:

auth_attr:files ldap

Files

/etc/nsswitch.conf

/etc/user_attr

/etc/security/auth_attr

Locally added entries. Make sure that the shipped header remains intact.

/etc/security/auth_attr.d/*

Entries added by package installation.

See Also

auths(1), getauthattr(3C), getexecattr(3C), getprofattr(3C), getuserattr(3C), exec_attr(5), nsswitch.conf(5), user_attr(5)

Notes

Because the list of legal keys is likely to expand, any code that parses this database must be written to ignore unknown key-value pairs without error. When any new keywords are created, the names should be prefixed with a unique string, such as the company's stock symbol, to avoid potential naming conflicts.

The following characters are used in describing the database format and must be escaped with a backslash if used as data: colon (:), semicolon (;), equals (=), and backslash (\).

The authorization required to add/modify/delete authorizations is solaris.auth.manage. The solaris.auth.assign authorization allows an authorized user to grant any authorization to a user. The solaris.auth.delegate allows an authorized user to grant only the user's authorizations to another user.