Represents the client Basic Auth provider, which is used to authenticate with an external endpoint by generating a
Basic Auth token against the provided credential configurations.
```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 Base64-encoded token for Basic Auth authentication.
```ballerina
string token = check provider.generateToken();
```



generateToken

The generated token or else an `auth:Error` if an error occurred


ClientBasicAuthProvider

Represents the file user store based listener Basic Auth provider, which is used to authenticate the provided
credentials against the provided file user store configurations.
```ballerina
auth:ListenerFileUserStoreBasicAuthProvider provider = new;
```
The users are denoted by a section in the `Config.toml` 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.
```
[[ballerina.auth.users]]
username = "alice"
password = "password1"
scopes = ["scope1", "scope2"]
```


Provides authentication based on the provided configurations.



fileUserStoreConfig

FileUserStoreConfig

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



authenticate

The Base64-encoded `username:password` value


credential

string

`auth:UserDetails` if the authentication is successful or else an `auth:Error` if an error occurred


ListenerFileUserStoreBasicAuthProvider

Represents the LDAP-based listener Basic Auth provider, which is used to authenticate the provided credentials
against the provided LDAP user store configurations. This connects to an active directory or an LDAP, retrieves
the necessary user information, and performs authentication and authorization.
```ballerina
auth:LdapUserStoreConfig config = {
    domainName: "ballerina.io",
    connectionURL: "ldap://localhost:389",
    connectionName: "cn=admin,dc=avix,dc=lk"
};
auth:ListenerLdapUserStoreBasicAuthProvider provider = new(config);
```


Creates an LDAP auth store with the provided configurations.



ldapUserStoreConfig

LdapUserStoreConfig

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



ListenerLdapUserStoreBasicAuthProvider

## Overview

This module provides a framework for authentication/authorization based on the Basic Authentication scheme specified in [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617).

The Basic Authentication scheme transmits credentials as user-id/password pairs encoded using Base64. This scheme is not considered to be a secure method of user authentication unless used in conjunction with some external secure system such as TLS as the user ID and password are passed over the network as cleartext.

The Ballerina `auth` module facilitates auth providers that are to be used by the clients and listeners of different protocol connectors.

### Listener File User Store Basic Auth Provider

Represents the file user store based listener Basic Auth provider, which is used to authenticate the provided credentials against the provided file user store configurations. The users are denoted by a section in the `Config.toml` 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.

```toml
[[ballerina.auth.users]]
username="alice"
password="xxx"
scopes=["read", "write"]
```

### Listener LDAP User Store Basic Auth Provider

Represents the LDAP-based listener Basic Auth provider, which is used to authenticate the provided credentials against the provided LDAP user store configurations. This connects to an active directory or an LDAP, which retrieves the necessary user information and performs authentication and authorization.

### Client Basic Auth Provider

Represents the client Basic Auth provider, which is used to authenticate with an external endpoint by generating a Basic Auth token against the provided credential configurations.


Represents the error type of the module. 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 providers try to generate
the token.


Error

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



extractUsernameAndPassword

A `string` tuple with the extracted username and password or else an `auth:Error` if an error occurred


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).



ListenerBasicAuthProvider

Represents credentials for Basic Auth authentication.



username

password

Represents the file user store configurations.


Represents the LDAP user store configurations.



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

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 module provides a framework for authentication/authorization based on the Basic Authentication scheme specified in [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617).


Object type: ListenerBasicAuthProvider

Methods

authenticate

Parameters

Return Type