io.aeron.security.CredentialsSupplier Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aeron-agent Show documentation

Efficient reliable UDP unicast, UDP multicast, and IPC transport protocol.

There is a newer version: 1.46.2

/*
 * Copyright 2014-2023 Real Logic Limited.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.aeron.security;

/**
 * Supplier of credentials for authentication with a system.
 * 
 * Implement this interface to supply credentials for clients. If no credentials are required then the
 * {@link NullCredentialsSupplier} can be used.
 */
public interface CredentialsSupplier
{
    /**
     * Provide encoded credentials to be included in Session Connect message a system.
     *
     * @return encoded credentials to be included in the Session Connect message to a system.
     */
    byte[] encodedCredentials();

    /**
     * Given some encoded challenge, provide the credentials to be included in a Challenge Response as part of
     * authentication with a system.
     *
     * @param encodedChallenge from the cluster to use in providing a credential.
     * @return encoded credentials to be included in the Challenge Response to the system.
     */
    byte[] onChallenge(byte[] encodedChallenge);
}