|
| 1 | +/* |
| 2 | + * Copyright 2025, Google Inc. All rights reserved. |
| 3 | + * |
| 4 | + * Redistribution and use in source and binary forms, with or without |
| 5 | + * modification, are permitted provided that the following conditions are |
| 6 | + * met: |
| 7 | + * |
| 8 | + * * Redistributions of source code must retain the above copyright |
| 9 | + * notice, this list of conditions and the following disclaimer. |
| 10 | + * * Redistributions in binary form must reproduce the above |
| 11 | + * copyright notice, this list of conditions and the following disclaimer |
| 12 | + * in the documentation and/or other materials provided with the |
| 13 | + * distribution. |
| 14 | + * |
| 15 | + * * Neither the name of Google Inc. nor the names of its |
| 16 | + * contributors may be used to endorse or promote products derived from |
| 17 | + * this software without specific prior written permission. |
| 18 | + * |
| 19 | + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 20 | + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 21 | + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 22 | + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 23 | + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 24 | + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 25 | + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 26 | + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 27 | + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 28 | + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 29 | + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | + */ |
| 31 | + |
| 32 | +package com.google.auth.mtls; |
| 33 | + |
| 34 | +import com.google.api.client.http.javanet.NetHttpTransport; |
| 35 | +import com.google.auth.http.HttpTransportFactory; |
| 36 | +import java.security.GeneralSecurityException; |
| 37 | +import java.security.KeyStore; |
| 38 | +import java.util.Objects; |
| 39 | + |
| 40 | +/** |
| 41 | + * An HttpTransportFactory that creates {@link NetHttpTransport} instances configured for mTLS |
| 42 | + * (mutual TLS) using a specific {@link KeyStore} containing the client's certificate and private |
| 43 | + * key. |
| 44 | + * |
| 45 | + * <p><b>Warning:</b> This class is considered internal and is not intended for direct use by |
| 46 | + * library consumers. Its API and behavior may change without notice. |
| 47 | + */ |
| 48 | +public class MtlsHttpTransportFactory implements HttpTransportFactory { |
| 49 | + private final KeyStore mtlsKeyStore; |
| 50 | + |
| 51 | + /** |
| 52 | + * Constructs a factory for mTLS transports. |
| 53 | + * |
| 54 | + * @param mtlsKeyStore The {@link KeyStore} containing the client's X509 certificate and private |
| 55 | + * key. This {@link KeyStore} is used for client authentication during the TLS handshake. Must |
| 56 | + * not be null. |
| 57 | + */ |
| 58 | + public MtlsHttpTransportFactory(KeyStore mtlsKeyStore) { |
| 59 | + this.mtlsKeyStore = Objects.requireNonNull(mtlsKeyStore, "mtlsKeyStore cannot be null"); |
| 60 | + } |
| 61 | + |
| 62 | + @Override |
| 63 | + public NetHttpTransport create() { |
| 64 | + try { |
| 65 | + // Build the mTLS transport using the provided KeyStore. |
| 66 | + return new NetHttpTransport.Builder().trustCertificates(null, mtlsKeyStore, "").build(); |
| 67 | + } catch (GeneralSecurityException e) { |
| 68 | + // Wrap the checked exception in a RuntimeException because the HttpTransportFactory |
| 69 | + // interface's create() method doesn't allow throwing checked exceptions. |
| 70 | + throw new RuntimeException("Failed to initialize mTLS transport.", e); |
| 71 | + } |
| 72 | + } |
| 73 | +} |
0 commit comments