Represents the client Basic Auth provider. This uses the `auth:CredentialsConfig` configurations provided and generes
the token for Basic Auth authentication.
```ballerina
 auth:CredentialsConfig config = {
     username: "tom",
     password: "123"
 }
 auth:ClientBasicAuthProvider provider = new(config);
 ```


Provides authentication based on the provided Basic Auth configurations.



init

credentialsConfig

CredentialsConfig

Generates a token for Basic Auth authentication.
```ballerina
string|auth:Error token = provider.generateToken();
```



generateToken

The generated token or else an `auth:Error` occurred during the validation


ClientBasicAuthProvider

Represents the file user store based listener Basic Auth provider, which is an implementation of the
`auth:ListenerBasicAuthProvider` object.
```ballerina
 auth:ListenerFileUserStoreBasicAuthProvider provider = new;
 ```
The users are denoted by a section in the Ballerina configurations file. The username, password and the scopes
of a particular user are denoted as keys under the users section as shown below. For multiple users, the complete
section has to be duplicated.
```
[[auth.users]]
username = "alice"
password = "password1"
scopes = ["scope1", "scope2"]
```


ListenerBasicAuthProvider

Provides authentication based on the provided configurations.



fileUserStoreConfig

FileUserStoreConfig

Authenticate the base64-encoded `username:password` credentials.
```ballerina
auth:UserDetails|auth:Error result = provider.authenticate("<credential>");
```



authenticate

Base64-encoded `username:password` value


credential

string

`auth:UserDetails` if the authentication is successful, `auth:Error` in case of an error of
authentication failure


ListenerFileUserStoreBasicAuthProvider

Represents the LDAP based listener Basic Auth provider. This connects to an active directory or an LDAP,
retrieves the necessary user information, and performs authentication and authorization. This is an implementation
of the `auth:ListenerBasicAuthProvider` object.
```ballerina
 auth:LdapUserStoreConfig config = {
     domainName: "ballerina.io",
     connectionURL: "ldap://localhost:389",
     connectionName: "cn=admin,dc=avix,dc=lk"
 };
 auth:ListenerLdapUserStoreBasicAuthProvider provider = new(config);
 ```
A user is denoted by a section in the Ballerina configuration file. The password and the scopes assigned to the user
are denoted as keys under the relevant user section as shown below.
```
[b7a.users.<username>]
password="<password>"
scopes="<comma_separated_scopes>"
```


Creates an LDAP auth store with the provided configurations.



ldapUserStoreConfig

LdapUserStoreConfig

Attempts to authenticate the base64-encoded `username:password` credentials.
```ballerina
auth:UserDetails|auth:Error result = provider.authenticate("<credential>");
```



ListenerLdapUserStoreBasicAuthProvider

## Package Overview

This package provides listener Basic authentication providers, which can be used to authenticate the provided credentials against a file user store or an LDAP user store, and a client Basic authentication provider, which can be used to authenticate against an external endpoint.

For information on the operations, which you can perform with this package, see the below **Functions**. For examples on the usage of the operations, see the following.
* [HTTP Service with Basic Auth File User Store](https://ballerina.io/learn/by-example/http-service-with-basic-auth-file-user-store.html)
* [HTTP Service with Basic Auth LDAP User Store](https://ballerina.io/learn/by-example/http-service-with-basic-auth-ldap-user-store.html)
* [HTTP Client with Basic Auth Example](https://ballerina.io/learn/by-example/http-client-with-basic-auth.html)


Represents the Auth error. This will be returned if an error occurred while any of the listener Basic Auth providers
try to authenticate the received credentials and client Basic Auth provider try to generate the token.


Error

Extracts the username and the password from the base64-encoded `username:password` value.
```ballerina
[string, string]|auth:Error [username, password] = auth:extractUsernameAndPassword("<credential>");
```



extractUsernameAndPassword

A `string` tuple with the extracted username and password or else an `auth:Error` occurred while
extracting credentials


Represents the listener Basic Auth provider, which could be used to authenticate credentials.
The `auth:ListenerBasicAuthProvider` acts as the interface for all the Basic Auth listener authentication providers.
Any type of implementation such as file store, LDAP user store, in memory user store, JDBC user store etc. should be
object-wise similar.


Authenticates the user based on the user credentials (i.e., the username/password).



Represents credentials for Basic Auth authentication.



username

password

Represents the file user store configurations.


Represents the configurations that are required for an LDAP user store.



domainName

connectionUrl

The username used to connect to the LDAP server


connectionName

The password used to connect to the LDAP server


connectionPassword

DN of the context or object under which the user entries are stored in the LDAP server


userSearchBase

Object class used to construct user entries


userEntryObjectClass

The attribute used for uniquely identifying a user entry


userNameAttribute

Filtering criteria used to search for a particular user entry


userNameSearchFilter

Filtering criteria for searching user entries in the LDAP server


userNameListFilter

DN of the context or object under which the group entries are stored in the LDAP server


groupSearchBase

Object class used to construct group entries


groupEntryObjectClass

The attribute used for uniquely identifying a group entry


groupNameAttribute

Filtering criteria used to search for a particular group entry


groupNameSearchFilter

Filtering criteria for searching group entries in the LDAP server


groupNameListFilter

Define the attribute, which contains the distinguished names (DN) of user objects that are there in a group


membershipAttribute

To indicate whether to cache the role list of a user


userRolesCacheEnabled

boolean

Define whether LDAP connection pooling is enabled


connectionPoolingEnabled

Connection timeout (in seconds) when making the initial LDAP connection


connectionTimeout

decimal

Reading timeout (in seconds) for LDAP operations


readTimeout

The SSL configurations for the LDAP client socket. This needs to be configured in order to communicate through LDAPs


secureSocket

SecureSocket

Configures the SSL/TLS options to be used for LDAP communication.



Configurations associated with the `crypto:TrustStore` or single certificate file that the client trusts


cert

TrustStore

Represents the details of the authenticated user.



scopes

UserDetails

This package provides listener Basic authentication providers, which can be used to authenticate the provided credentials against a file user store or an LDAP user store, and a client Basic authentication provider, which can be used to authenticate against an external endpoint.


Represents the client Basic Auth provider.

Represents the file user store based listener Basic Auth provider, which is an implementation of the
`auth:ListenerBasicAuthProvider` object.

Represents the LDAP based listener Basic Auth provider.

Extracts the username and the password from the base64-encoded `username:password` value.

This package provides listener Basic authentication providers, which can be used to authenticate the provided credentials against a file user store or an LDAP user store, and a client Basic authentication provider, which can be used to authenticate against an external endpoint.

Represents the listener Basic Auth provider, which could be used to authenticate credentials.

Represents credentials for Basic Auth authentication.

Represents the file user store configurations.

Represents the configurations that are required for an LDAP user store.

Configures the SSL/TLS options to be used for LDAP communication.

Represents the details of the authenticated user.

ballerina/auth
1.1.0-alpha8
2.3.1 2.3.0 2.2.1 2.2.0 2.1.0 2.0.1 2.0.0 1.1.0-beta.2 1.1.0-beta.1 1.1.0-alpha8

Package Overview

Functions

Classes

Object types

Records

Errors

ballerina/auth1.1.0-alpha82.3.12.3.02.2.12.2.02.1.02.0.12.0.01.1.0-beta.21.1.0-beta.11.1.0-alpha8