Skip to content

Add README for oauth2 core and helidon JwtAuthFilter #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions avaje-oauth2-core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# avaje-oauth2-core

Provides core OAuth2 features.


### JwtVerifier

JwtVerifier verifies a Signed JWT Access token is valid.

```java
String issuer = "https://cognito-idp.REGION.amazonaws.com/REGION_FOO";

JwtVerifier jwtVerifier = JwtVerifier.builder()
.issuer(issuer)
.build();

String rawAccessToken = ...;

try {
// verify that the raw access token is valid, and return
// the parsed AccessToken
AccessToken accessToken = verifier.verifyAccessToken(rawAccessToken);
} catch (JwtVerifyException exception) {
// invalid access token
}
```


### SignedJwt

Parse a SignedJwt.

```java
String rawToken = "eyJraWQiOiJqR3lQcEc4MDNTc1ZmSjRtZERkVktE...";
SignedJwt token = SignedJwt.parse(rawToken);

```
35 changes: 35 additions & 0 deletions avaje-oauth2-helidon-jwtfilter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

# avaje-oauth2-helidon-jwtfilter

Provides a Helidon Filter that ensures a valid Signed JWT access token
is supplied as a `Authorization` `Bearer` http header.

### Typical use

- Build a JwtVerifier typically using an issuer endpoint
- Build a JwtAuthFilter
- Register the JwtAuthFilter as a Filter with the Helidon Webserver

```java
String issuer = "https://cognito-idp.REGION.amazonaws.com/REGION_FOO";

JwtVerifier jwtVerifier = JwtVerifier.builder()
.issuer(issuer)
.build();

JwtAuthFilter filter = JwtAuthFilter.builder()
.permit("/health")
.permit("/ping")
.verifier(jwtVerifier)
.build();
```

## Dependency

```xml
<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-oauth2-helidon-jwtfilter</artifactId>
<version>0.1</version>
</dependency>
```