summaryrefslogtreecommitdiffstats
path: root/docs/auth/tacacsplus.md
diff options
context:
space:
mode:
authorJohn Westcott IV <32551173+john-westcott-iv@users.noreply.github.com>2023-06-02 16:03:56 +0200
committerGitHub <noreply@github.com>2023-06-02 16:03:56 +0200
commit844666df4ca4b406568d5d58180d7a4719872c36 (patch)
treea308ebaa18b09b8f136c2a634f777836cd96b375 /docs/auth/tacacsplus.md
parent[rsyslog] Enable disk-assisted queuing on output (#14005) (diff)
downloadawx-844666df4ca4b406568d5d58180d7a4719872c36.tar.xz
awx-844666df4ca4b406568d5d58180d7a4719872c36.zip
Send real client remote address in TACACS+ authentication packet (#14077)
Co-authored-by: ekougs <ekougs@gmail.com>
Diffstat (limited to '')
-rw-r--r--docs/auth/tacacsplus.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/auth/tacacsplus.md b/docs/auth/tacacsplus.md
index cda18cb3e6..f895ed4aeb 100644
--- a/docs/auth/tacacsplus.md
+++ b/docs/auth/tacacsplus.md
@@ -8,7 +8,8 @@ TACACS+ is configured by settings configuration and is available under `/api/v2/
"TACACSPLUS_PORT": 49,
"TACACSPLUS_SECRET": "secret",
"TACACSPLUS_SESSION_TIMEOUT": 5,
- "TACACSPLUS_AUTH_PROTOCOL": "ascii"
+ "TACACSPLUS_AUTH_PROTOCOL": "ascii",
+ "TACACSPLUS_REM_ADDR": "false"
}
```
Each field is explained below:
@@ -20,6 +21,7 @@ Each field is explained below:
| `TACACSPLUS_SECRET` | String | '' (empty string) | Shared secret for authenticating to TACACS+ server. |
| `TACACSPLUS_SESSION_TIMEOUT` | Integer | 5 | TACACS+ session timeout value in seconds. |
| `TACACSPLUS_AUTH_PROTOCOL` | String with choices | 'ascii' | The authentication protocol used by TACACS+ client (choices are `ascii` and `pap`). |
+| `TACACSPLUS_REM_ADDR` | Boolean | false | Enable the client address sending by TACACS+ client. |
Under the hood, AWX uses [open-source TACACS+ python client](https://github.com/ansible/tacacs_plus) to communicate with the remote TACACS+ server. During authentication, AWX passes username and password to TACACS+ client, which packs up auth information and sends it to the TACACS+ server. Based on what the server returns, AWX will invalidate login attempt if authentication fails. If authentication passes, AWX will create a user if she does not exist in database, and log the user in.