1 /* 2 * Copyright 2023 Google LLC 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 LLC 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.oauth2; 33 34 /** 35 * A handler for generating the x-goog-api-client header value for BYOID external account 36 * credentials. 37 */ 38 class ExternalAccountMetricsHandler implements java.io.Serializable { 39 private static final String SOURCE_KEY = "source"; 40 private static final String IMPERSONATION_KEY = "sa-impersonation"; 41 private static final String CONFIG_LIFETIME_KEY = "config-lifetime"; 42 private static final String BYOID_METRICS_SECTION = "google-byoid-sdk"; 43 44 private final boolean configLifetime; 45 private final boolean saImpersonation; 46 private ExternalAccountCredentials credentials; 47 48 /** 49 * Constructor for the external account metrics handler. 50 * 51 * @param creds the {@code ExternalAccountCredentials} object to set the external account metrics 52 * options from. 53 */ ExternalAccountMetricsHandler(ExternalAccountCredentials creds)54 ExternalAccountMetricsHandler(ExternalAccountCredentials creds) { 55 this.saImpersonation = creds.getServiceAccountImpersonationUrl() != null; 56 this.configLifetime = 57 creds.getServiceAccountImpersonationOptions().customTokenLifetimeRequested; 58 this.credentials = creds; 59 } 60 61 /** 62 * Gets the external account metrics header value for the x-goog-api-client header. 63 * 64 * @return the header value. 65 */ getExternalAccountMetricsHeader()66 String getExternalAccountMetricsHeader() { 67 return String.format( 68 "%s %s %s/%s %s/%s %s/%s", 69 MetricsUtils.getLanguageAndAuthLibraryVersions(), 70 BYOID_METRICS_SECTION, 71 SOURCE_KEY, 72 this.credentials.getCredentialSourceType(), 73 IMPERSONATION_KEY, 74 this.saImpersonation, 75 CONFIG_LIFETIME_KEY, 76 this.configLifetime); 77 } 78 } 79