vespa-athenz/src/main/java/com/yahoo/vespa/athenz/identity/ServiceIdentityProvider.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.athenz.identity;

import com.yahoo.container.jdisc.athenz.AthenzIdentityProvider;
import com.yahoo.security.X509CertificateWithKey;
import com.yahoo.vespa.athenz.api.AthenzIdentity;

import javax.net.ssl.SSLContext;
import java.nio.file.Path;

/**
 * A interface for types that provides the Athenz service identity (SIA) from the environment.
 * Some similarities to {@link AthenzIdentityProvider}, but this type is not public API and intended for internal use.
 *
 * @author bjorncs
 */
public interface ServiceIdentityProvider {
    /**
     *
     * @return The Athenz identity of the environment
     */
    AthenzIdentity identity();

    /**
     * @return {@link SSLContext} that is automatically updated.
     */
    SSLContext getIdentitySslContext();

    /**
     * @return Current certificate and private key. Unlike {@link #getIdentitySslContext()} underlying credentials are not automatically updated.
     */
    X509CertificateWithKey getIdentityCertificateWithKey();

    /**
     * @return Path to X.509 certificate in PEM format
     */
    Path certificatePath();

    /**
     * @return Path to private key in PEM format
     */
    Path privateKeyPath();

}