-
Notifications
You must be signed in to change notification settings - Fork 180
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added instructions to docs for adding custom user roles (#6652)
- Loading branch information
Rick Larsen
authored
Oct 27, 2021
1 parent
8f5f0dc
commit 4480e79
Showing
8 changed files
with
82 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
...s/src/main/resources/content/_managing/_configuring/restricting-app-access.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
:title: Restricting Access to Features, Apps, Services, and Configurations | ||
:type: configuration | ||
:status: published | ||
:parent: Configuring User Access | ||
:summary: Restricting User Access to Features, Apps, Services, and Configurations | ||
:order: 051 | ||
|
||
== {title} | ||
((({title}))) | ||
|
||
* *{hardening-step}* | ||
|
||
Limit access to the individual applications, features, or services to those users who need access. | ||
Organizational requirements should dictate which applications are restricted and the extent to which they are restricted. | ||
|
||
. Navigate to the *${admin-console}*. | ||
. Select the *${ddf-admin}* application. | ||
. Select the *Configuration* tab. | ||
. Select the *Admin Configuration Policy*. | ||
. To add a feature or app permission: | ||
.. Add a new field to "Feature and App Permissions" in the format of: | ||
+ | ||
`<feature name>/<app name> = "attribute name=attribute value","attribute name2=attribute value2", ...` | ||
+ | ||
.. For example, to restrict access of any user without an admin role to the catalog-app: | ||
+ | ||
`catalog-app = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role=admin", ...` | ||
+ | ||
. To add a configuration permission: | ||
.. Add a new field to "Configuration Permissions" in the format of: | ||
+ | ||
`configuration id = "attribute name=attribute value","attribute name2=attribute value2", ...` | ||
.. For example, to restrict access of any user without an admin role to the Web Context Policy Manager: | ||
+ | ||
`org.codice.ddf.security.policy.context.impl.PolicyManager="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role=admin"` | ||
|
||
If a permission is specified, any user without the required attributes is unable to see or modify the feature, app, or configuration. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
...bution/docs/src/main/resources/content/_quickstart/quickstart-adding-roles.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
:title: Adding New User Roles | ||
:type: quickStart | ||
:level: section | ||
:section: quickStart | ||
:parent: Quick Start Tutorial | ||
:status: published | ||
:summary: Adding new user roles for limiting access to specific contexts | ||
:order: 03 | ||
|
||
== {title} | ||
((({title}))) | ||
|
||
Users or user groups can be customized to enable or restrict access to specific certain system functions. | ||
Define a custom role and assign it to users who need specific access. | ||
|
||
For an example, limit the replication admin view to users with a `sr_analyst` role. | ||
|
||
.Define a new role | ||
. Navigate to the ${admin-console}. | ||
. Navigate to the ${ddf-security} app. | ||
. Navigate to the *Configuration* tab. | ||
. Select the *Web Context Policy Manager* Configuration. | ||
. Select *Required Attributes*. | ||
. Define the contexts to be restricted. | ||
.. Enter `<CONTEXT>={http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role=<ROLE_NAME>` | ||
... For example, enter `/admin/replication={http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role=sr_analyst}` | ||
... Select the *+* sign to add another required attribute. | ||
... Enter `/admin/hub/graphql={http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role=sr_analyst}` | ||
|
||
.Assign the new role to users | ||
. Add the new role (`sr_analyst`) to selected users in the `users.properties` file. Add the role to the line of each chosen user. | ||
.. For example, `user1=password,sr_analyst` | ||
. Restart Alliance to apply the changes. | ||
.. `/app/bin/stop` | ||
.. `/app/bin/start` | ||
|
||
In the example given, the `/admin/replication` context is only accessible to users with the `sr_analyst` role. | ||
Other roles can be designated as needed by substituting the `<CONTEXT>` and the `<ROLE_NAME>` as needed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters