Jim
86192f75eb
* feature (auth): required schema changes for auth ldap method (#2669) chore (auth/ldap): move schema changes to next avail migration number * feature (auth/ldap): define AuthMethod and all its value objects (#2703) * feature (auth/ldap): storage protos * feature (auth/ldap): define AuthMethod and all its value objects * feature (auth/ldap): add repo and reading an auth method (#2718) * feature (auth/ldap): add Repository.CreateAuthMethod(...) and Repository.DeleteAuthMethod(...) (#2724) * feature (auth/ldap): add Repository.UpdateAuthMethod(...) (#2739) * feature (auth/ldap): add Account * feature (auth/ldap): add AuthMethod.EnableGroups * fix (auth/ldap): refactor AuthMethod.oplog to enforce proper constraints * feature (auth/ldap): add Account repo functions * refactor (auth/ldap): remove entry attributes from account Realized the entry attributes could have absolutely anything in them (including binary data) and since we absolutely don't have to have them there's just no reason to take on the risk. * feature (auth/ldap): add AuthMethod.UseTokenGroups * feature (auth/ldap): add Authenticate(...) * refactor (auth/ldap): ensure options take a context as the 1st parameter * feature (auth/ldap): add Account attribute maps * chore (auth/ldap): make fmt deltas * feature (auth/ldap): add managed groups (#2760) * tests (auth/ldap): add missing unit test to Repository.DeleteAccount(...) Add bits to test the delete operation when you're not able to generate oplog metadata * feature (auth/ldap): add managed groups fixup! feature (auth/ldap): add managed groups (#2760) * feature (auth/ldap): service proto definition (#2761) * feature (handlers/authmethods): add handlers for ldap auth method operations (#2794) * feature (auth/ldap): add Account attribute maps * chore (auth/ldap): update cap/ldap to latest version * feature (auth/ldap): add ldap api generation definitions * feature (authmethods): add ldap repo NewService(...) * feature (authmethods/ldap): add proper mask_mapping to protobufs * feature (authmethods): add support to get an ldap auth method * refactor (auth/ldap): export TestGenerateCA(...) * feature (authmethods): add support to create an ldap auth method * feature (authmethods): add support to delete an ldap auth method * feature (authmethods): add support to list ldap auth methods * refactor (auth/ldap): make urls optional for NewAuthMethod(...) * refactor (auth/ldap): export ldap.TestInvalidPem * chore: make fmt changes * fix (auth/ldap): properly handle group search config Add constraints and tests to ensure when an ldap AuthMethod.EnableGroups is true, and UseTokenGroups is false; that there's a GroupDn configured for finding a user's associated groups * feature (authmethods): add support to update an ldap auth methods * chore (db/ldap): tmp mv migrations so there's no conflict with ongoing work * feature (verifier): add ldap auth method to verifier bits * fix (controller): prevent panic when controller stops when there's no listener * feature (authmethods): add support to authenticate via ldap auth methods * chore (migrations): fix whitespace in stmt * chore: fmt fixup * tests (auth/ldap): invalid err msg * feature (cli/authmethods): add support for ldap auth-methods CRUD and authenticate (#2810) * feature (authmethods): add CLI support for ldap auth methods CRUD * tests (api/auth): ldap auth method classification tests * feature (authmethods): add CLI support for ldap auth authenticate * feature (auth/ldap): set request timeouts for ldap server connections * feature (handlers/authmethods): handle u_anon listing properly. * feature (account/handers): ldap account and managed group CRUDL APIs (#2852) * feature (auth/ldap) add repository Listing of ManagedGroupMemberAccount * feature (controller/handlers): add ldapRepoFn to accounts service * feature (auth/ldap) register ldap managed group subtype * feature (account/handlers): ldap account CRUDL APIs * feature (controller/handlers): add ldapRepo to managed groups service * feature (account/handlers): ldap managed group CRUDL APIs * docs (domain): add LDAP accounts, auth-methods and managed groups (#2857) * feature (ldap/cli) add ldap accounts and managed groups CRUDL commands (#2856) * fix (handlers/authmethods): fix ldap authorized actions (#2892) * feature (cli/ldap/authenticate): use primary auth method if none is provided (#2890) * fix (auth/ldap): support setting the state attribute * feature (cli/ldap/authenticate): use primary auth method if none is provided * feature (wh/ldap) add tests for new ldap auth method and accounts (#2919) * refactor (migrations/ldap): mv to correct directory * chore: add copyright headers * fix (api/authmethods/ldap): renumber new LdapAuthMethodAttributes field * fix (auth/ldap): allow the auth method state to be updated (#2951) * chore: update sdk and api versions for llb - this is tmp until merging * tests (managed groups): add required errContains for new test
149 lines
5.9 KiB
Plaintext
149 lines
5.9 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Domain Model - Auth Methods
|
|
description: |-
|
|
The anatomy of a Boundary auth method
|
|
---
|
|
|
|
# Auth Methods
|
|
|
|
An auth method is a resource that provides a mechanism for [users][] to
|
|
authenticate to Boundary. An auth method contains [accounts][] which link an
|
|
individual user to a set of credentials and [managed groups][] which groups
|
|
[accounts][] that satisfy criteria and can be used as principals in [roles][].
|
|
Auth methods can be defined at either a [Global][] or [Organization][]
|
|
[scope][].
|
|
|
|
## Attributes
|
|
|
|
All auth methods have the following configurable attributes:
|
|
|
|
- `name` - (optional)
|
|
If set, the `name` must be unique within the auth method's scope.
|
|
|
|
- `description` - (optional)
|
|
|
|
### Password Auth Method Attributes
|
|
|
|
The password auth method has the following additional attributes:
|
|
|
|
- `min_login_name_length` - (required) The default is 3.
|
|
|
|
- `min_password_length` - (required) The default is 8.
|
|
|
|
### LDAP Auth Method Attributes
|
|
|
|
The ldap auth method has the following additional attributes:
|
|
|
|
- `state` - The state of the auth method; either inactive, active-private, or
|
|
active-public.
|
|
|
|
- `start_tls` - (optional) If true, issues a StartTLS command after establishing
|
|
an unencrypted connection. Defaults to false.
|
|
|
|
- `insecure_tls` - (optional) If true, skips LDAP server SSL certificate
|
|
validation, which is insecure and should be used with caution. Defaults to
|
|
false.
|
|
|
|
- `discover_dn` - (optional) If true, use anon bind to discover the bind DN
|
|
(Distinguished Name) of a user. Defaults to false.
|
|
|
|
- `anon_group_search` - (optional) If true, use anon bind when performing LDAP
|
|
group searches. Defaults to false.
|
|
|
|
- `upn_domain` - (optional) If set, the userPrincipalDomain is used to construct
|
|
the UPN string for the authenticating user. The constructed UPN appears as
|
|
[username]@UPNDomain Example: example.com, which causes Boundary to
|
|
bind as username@example.com when it authenticates the user.
|
|
|
|
- `urls` - (required) The LDAP URLS that specify LDAP servers to connect to.
|
|
There must be at least one URL for each LDAP auth method. When attempting to
|
|
connect, the URLs are tried in the order specified.
|
|
|
|
- `user_dn` - (optional) If set, the base DN under which to perform user
|
|
search. Example: ou=Users,dc=example,dc=com
|
|
|
|
- `user_attr` - (optional) If set, defines the attribute on a user's entry
|
|
matching the login-name passed when the user authenticates. Examples: cn, uid
|
|
|
|
- `user_filter` - (optional) If set, the Go template used to construct an LDAP
|
|
user search filter. The template can access the following context variables:
|
|
[UserAttr, Username]. The default user_filter is ({{.UserAttr}}={{.Username}})
|
|
or (userPrincipalName={{.Username}}@UPNDomain) if the upn-domain parameter is
|
|
set.
|
|
|
|
- `enable_groups` - (optional) If true, an authenticated user's groups are
|
|
found during authentication. Defaults to false.
|
|
|
|
- `group_dn` - (optional) If set, the base DN under which to perform a group
|
|
search. Example: ou=Groups,dc=example,dc=com
|
|
|
|
Note: There is no default, so no base DN is used for group searches, if
|
|
it's not specified.
|
|
|
|
- `group_attr` - (optional) If set, the LDAP attribute to follow on objects
|
|
returned by group_filter in order to enumerate user group membership.
|
|
Examples: for group_filter queries returning group objects, use: cn. For
|
|
queries returning user objects, use: memberOf. The default is cn.
|
|
|
|
- `group_filter` - (optional) If set, the Go template used when constructing the
|
|
group membership query. The template can access the following context
|
|
variables: [UserDN, Username]. The default is
|
|
(|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}})),
|
|
which is compatible with several common directory schemas.
|
|
|
|
- `certificates` - (optional) If set, PEM encoded x509 certificates in ASN.1
|
|
DER form that can be used as trust anchors when connecting to an LDAP
|
|
provider.
|
|
|
|
- `client_certificate` - (optional) If set, a PEM encoded x509 certificate in
|
|
ASN.1 DER form to be used as a client certificate. It must be set, if you
|
|
specify the optional client_certificate_key.
|
|
|
|
- `client_certificate_key` - (optional) If set, a PEM encoded certificate key in
|
|
PKCS #8, ASN.1 DER form. It must be set, if you specify the optional
|
|
client_certificate.
|
|
|
|
- `bind_dn` - (optional) If set, the distinguished name of entry to bind when
|
|
performing user and group searches. Example:
|
|
cn=vault,ou=Users,dc=example,dc=com
|
|
|
|
- `bind_password` - (optional) If set, the password to use along with bind_dn
|
|
when performing user search. It must be set, if you specify the optional
|
|
bind_dn.
|
|
|
|
- `use_token_groups` - (optional) If true, use the Active Directory tokenGroups
|
|
constructed attribute of the user to find the group memberships. This
|
|
finds all security groups, including nested ones.
|
|
|
|
- `account_attribute_maps` - (optional) If set, the attribute maps from custom
|
|
attributes to the standard fullname and email account attributes. These
|
|
maps are represented as key=value where the key equals the from_attribute, and
|
|
the value equals the to_attribute. For example, "preferredName=fullName". All
|
|
attribute names are case insensitive.
|
|
|
|
|
|
## Referenced By
|
|
|
|
- [Account][]
|
|
- [Global][]
|
|
- [Managed Group][]
|
|
- [Organization][]
|
|
|
|
[account]: /boundary/docs/concepts/domain-model/accounts
|
|
[accounts]: /boundary/docs/concepts/domain-model/accounts
|
|
[global]: /boundary/docs/concepts/domain-model/scopes#global
|
|
[managed group]: /boundary/docs/concepts/domain-model/managed-groups
|
|
[managed groups]: /boundary/docs/concepts/domain-model/managed-groups
|
|
[organization]: /boundary/docs/concepts/domain-model/scopes#organizations
|
|
[roles]: /boundary/docs/concepts/domain-model/roles
|
|
[scope]: /boundary/docs/concepts/domain-model/scopes
|
|
[users]: /boundary/docs/concepts/domain-model/users
|
|
|
|
## Service API Docs
|
|
|
|
The following services are relevant to this resource:
|
|
|
|
- [Auth Method Service](/boundary/api-docs/auth-method-service)
|
|
- [Auth Token Service](/boundary/api-docs/auth-token-service)
|