# flink-basic-auth-handler

**Repository Path**: it_ma_yun/flink-basic-auth-handler

## Basic Information

- **Project Name**: flink-basic-auth-handler
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: 1.17.1
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-12
- **Last Updated**: 2024-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Flink basic authentication handler

It implements custom netty HTTP request inbound/outbound handlers to add basic
authentication possibility to Flink.
Please see [FLIP-181](https://cwiki.apache.org/confluence/x/CAUBCw) for further details.

## How to build
In order to build the project one needs maven and java.
Since the authentication handler is Flink version dependent please make sure the version are matching in `pom.xml`.
```
mvn clean install
```

## How to install
In order to install in one just needs to do the following:
* Make sure the following provided dependencies are available on the cluster:
  * `flink-runtime`
  * `commons-codec`
* Add the following jar to the classpath:
```
target/flink-basic-auth-handler-<VERSION>.jar
```
As described in the mentioned implementation proposal Flink loads all
inbound/outbound handlers with service loader automatically.

## How to configure

The following configuration properties are supported:

Property | Type | Default | Description
---------|------|---------|------------
security.basic.auth.enabled | boolean | false | Turns on/off basic authentication
security.basic.auth.password.file | string | (none) | Basic authentication password file
security.basic.auth.client.credentials | string | (none) | Basic authentication client credentials user:pwd

## License
This is licensed under Apache License Version 2.0.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.