Skip to content

Commit 6401e51

Browse files
ldetmerldetmer
authored
feat: add api key credential as client library authorization type (#1483)
* add api key credential * add no op * formatting fix * added tests for ApiKeyCredentials * formatting fix * added java docs * formatting fix * added error checking * removed PreCondition dependency * fixed * import * updated authenticationType to API-Key * updated to use assertThrows + expanded java docs
1 parent ea0dca6 commit 6401e51

File tree

2 files changed

+179
-0
lines changed

2 files changed

+179
-0
lines changed

‎credentials/java/com/google/auth/ApiKeyCredentials.java‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
/*
2+
* Copyright 2024, 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+
package com.google.auth;
32+
33+
import java.io.IOException;
34+
import java.net.URI;
35+
import java.util.Collections;
36+
import java.util.List;
37+
import java.util.Map;
38+
39+
/**
40+
* Credentials class for calling Google APIs using an API key.
41+
*
42+
* <p>Uses an API key directly in the request metadata to provide authorization.
43+
*
44+
* <p>Note: ApiKeyCredentials extends from base {@link Credentials} class rather than
45+
* GoogleCredentials/OAuth2Credentials, as it does not provide an access token and is not considered
46+
* an OAuth2 credential.
47+
*
48+
* <pre><code>
49+
* Credentials credentials = ApiKeyCredentials.create("your api key");
50+
* </code></pre>
51+
*/
52+
public class ApiKeyCredentials extends Credentials {
53+
static final String API_KEY_HEADER_KEY = "x-goog-api-key";
54+
private final String apiKey;
55+
56+
ApiKeyCredentials(String apiKey) {
57+
this.apiKey = apiKey;
58+
}
59+
60+
public static ApiKeyCredentials create(String apiKey) {
61+
if (apiKey == null || apiKey.isEmpty()) {
62+
throw new IllegalArgumentException("API key cannot be null or blank");
63+
}
64+
return new ApiKeyCredentials(apiKey);
65+
}
66+
67+
@Override
68+
public String getAuthenticationType() {
69+
return "API-Key";
70+
}
71+
72+
@Override
73+
public Map<String, List<String>> getRequestMetadata(URI uri) throws IOException {
74+
return Collections.singletonMap(API_KEY_HEADER_KEY, Collections.singletonList(apiKey));
75+
}
76+
77+
@Override
78+
public boolean hasRequestMetadata() {
79+
return true;
80+
}
81+
82+
@Override
83+
public boolean hasRequestMetadataOnly() {
84+
return true;
85+
}
86+
87+
/** There is no concept of refreshing an API tokens, this method is a no-op. */
88+
@Override
89+
public void refresh() throws IOException {}
90+
}

‎credentials/javatests/com/google/auth/ApiKeyCredentialsTest.java‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
/*
2+
* Copyright 2024, 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+
package com.google.auth;
32+
33+
import static org.junit.Assert.assertEquals;
34+
import static org.junit.Assert.assertThrows;
35+
import static org.junit.Assert.assertTrue;
36+
37+
import java.io.IOException;
38+
import java.net.URI;
39+
import java.net.URISyntaxException;
40+
import java.util.List;
41+
import java.util.Map;
42+
import org.junit.Test;
43+
import org.junit.runner.RunWith;
44+
import org.junit.runners.JUnit4;
45+
46+
/** Test case for {@link ApiKeyCredentials}. */
47+
@RunWith(JUnit4.class)
48+
public class ApiKeyCredentialsTest {
49+
50+
private static final String TEST_API_KEY = "testApiKey";
51+
52+
@Test
53+
public void testGetAuthenticationType() {
54+
ApiKeyCredentials credentials = ApiKeyCredentials.create(TEST_API_KEY);
55+
assertEquals("API-Key", credentials.getAuthenticationType());
56+
}
57+
58+
@Test
59+
public void testGetRequestMetadata() throws IOException, URISyntaxException {
60+
ApiKeyCredentials credentials = ApiKeyCredentials.create(TEST_API_KEY);
61+
Map<String, List<String>> metadata = credentials.getRequestMetadata(new URI("http://test.com"));
62+
assertEquals(1, metadata.size());
63+
assertTrue(metadata.containsKey(ApiKeyCredentials.API_KEY_HEADER_KEY));
64+
assertEquals(1, metadata.get(ApiKeyCredentials.API_KEY_HEADER_KEY).size());
65+
assertEquals(TEST_API_KEY, metadata.get(ApiKeyCredentials.API_KEY_HEADER_KEY).get(0));
66+
}
67+
68+
@Test
69+
public void testHasRequestMetadata() {
70+
ApiKeyCredentials credentials = ApiKeyCredentials.create(TEST_API_KEY);
71+
assertTrue(credentials.hasRequestMetadata());
72+
}
73+
74+
@Test
75+
public void testHasRequestMetadataOnly() {
76+
ApiKeyCredentials credentials = ApiKeyCredentials.create(TEST_API_KEY);
77+
assertTrue(credentials.hasRequestMetadataOnly());
78+
}
79+
80+
@Test
81+
public void testNullApiKey_ThrowsException() {
82+
assertThrows(IllegalArgumentException.class, () -> ApiKeyCredentials.create(null));
83+
}
84+
85+
@Test
86+
public void testBlankApiKey_ThrowsException() {
87+
assertThrows(IllegalArgumentException.class, () -> ApiKeyCredentials.create(""));
88+
}
89+
}

0 commit comments

Comments
 (0)