forked from grpc/grpc-java
-
Notifications
You must be signed in to change notification settings - Fork 1
/
CertificateProvider.java
65 lines (56 loc) · 2.3 KB
/
CertificateProvider.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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
* Copyright 2020 The gRPC Authors
*
* 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
*
* http://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.grpc.xds.internal.certprovider;
import io.grpc.Status;
import java.io.Closeable;
import java.security.PrivateKey;
import java.security.cert.X509Certificate;
import java.util.List;
/**
* A plug-in that provides certificates required by the xDS security component and created
* using the certificate-provider config from the xDS server.
*
* <p>We may move this out of the internal package and make this an official API in the future.
*
* <p>The plugin fetches certificates - root and optionally identity cert - required by xDS
* security.
*/
public abstract class CertificateProvider implements Closeable {
/** A watcher is registered via the constructor to receive updates for the certificates. */
public interface Watcher {
void updateCertificate(PrivateKey key, List<X509Certificate> certChain);
void updateTrustedRoots(List<X509Certificate> trustedRoots);
void onError(Status errorStatus);
}
/**
* Concrete subclasses will call this to register the {@link Watcher}.
*
* @param watcher to register
* @param notifyCertUpdates if true, the provider is required to call the watcher’s
* updateCertificate method. Implies the Provider is capable of minting certificates.
* Used by server-side and mTLS client-side. Note the Provider is always required
* to call updateTrustedRoots to provide trusted-root updates.
*/
protected CertificateProvider(Watcher watcher, boolean notifyCertUpdates) {
this.watcher = watcher;
this.notifyCertUpdates = notifyCertUpdates;
}
/** Releases all resources and stop cert refreshes and watcher updates. */
@Override
public abstract void close();
protected final Watcher watcher;
protected final boolean notifyCertUpdates;
}