org.starchartlabs.calamari.core.auth

Class ApplicationKey

java.lang.Object

org.starchartlabs.calamari.core.auth.ApplicationKey

All Implemented Interfaces:

java.util.function.Supplier<java.lang.String>

public class ApplicationKey
extends java.lang.Object
implements java.util.function.Supplier<java.lang.String>

Represents an authentication key used to validate web requests to GitHub as a GitHub App

Handles logic for reading a private (signing) key, signing a JWT token, and caching that token until it has expired, as described in authenticating as a GitHub App

Uses Java Supplier pattern to allow re-generation of tokens as needed

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
ApplicationKey(java.lang.String githubAppId, java.util.function.Supplier<java.lang.String> privateKeySupplier)
ApplicationKey(java.lang.String githubAppId, java.util.function.Supplier<java.lang.String> privateKeySupplier, int cacheExpirationMinutes)

Method Summary

Modifier and Type	Method and Description
java.lang.String	get()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationKey

public ApplicationKey(java.lang.String githubAppId,
                      java.util.function.Supplier<java.lang.String> privateKeySupplier)

Parameters:

githubAppId - Unique identifier provided by GitHub for the App

privateKeySupplier - Supplier which allows lookup of the private (signing) key issued by GitHub for creating JWT tokens used in web requests

Since:

0.1.0

ApplicationKey

public ApplicationKey(java.lang.String githubAppId,
                      java.util.function.Supplier<java.lang.String> privateKeySupplier,
                      int cacheExpirationMinutes)

Parameters:

githubAppId - Unique identifier provided by GitHub for the App

privateKeySupplier - Supplier which allows lookup of the private (signing) key issued by GitHub for creating JWT tokens used in web requests

cacheExpirationMinutes - Number of minutes to cache generated JWT tokens for authentication with GitHub, maximum 10

Since:

0.4.0

Method Detail

get

public java.lang.String get()
                     throws KeyLoadingException

Specified by:

get in interface java.util.function.Supplier<java.lang.String>

Returns:

Authorization header value to authenticate as a GitHub App

Throws:

KeyLoadingException - If the is an error reading the signing key prior to use

Since:

0.1.0