Package land.oras.auth

Class AuthStore

java.lang.Object

land.oras.auth.AuthStore

@NullMarked
public class AuthStore
extends Object

Implements a credentials store using a configuration file to keep the credentials in plain-text. Reference: Docker config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AuthStore.Credential	Nested Credential class to represent username and password pairs.
static final record	AuthStore.CredentialHelperResponse	Credential helper response

Method Summary

Modifier and Type	Method	Description
@Nullable AuthStore.Credential	get(ContainerRef containerRef)	Retrieves credentials for the given containerRef.
@Nullable String	getCredentialHelperBinary(ContainerRef containerRef)	Get the credential helper binary for the given containerRef.
static AuthStore	newStore()	Creates a new FileStore from default location
static AuthStore	newStore(List<Path> configPaths)	Creates a new FileStore based on the given configuration file path.

Methods inherited from class java.lang.Object

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

Method Details

newStore

public static AuthStore newStore(List<Path> configPaths)

Creates a new FileStore based on the given configuration file path.

Parameters:

configPaths - Path to the configuration files.

Returns:

FileStore instance.

newStore

public static AuthStore newStore()

Creates a new FileStore from default location

Returns:

FileStore instance.

get

public @Nullable AuthStore.Credential get(ContainerRef containerRef)
                                   throws OrasException

Retrieves credentials for the given containerRef.

Parameters:

containerRef - ContainerRef.

Returns:

Credential object or null if no credential is found.

Throws:

OrasException

getCredentialHelperBinary

public @Nullable String getCredentialHelperBinary(ContainerRef containerRef)

Get the credential helper binary for the given containerRef.

Parameters:

containerRef - ContainerRef.

Returns:

Credential helper binary name or null if not found.