-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add PKCE to 3LO exchange. (#1146)
* feat: Add PKCE to 3LO exchange.
- Loading branch information
Showing
5 changed files
with
295 additions
and
2 deletions.
There are no files selected for viewing
103 changes: 103 additions & 0 deletions
103
oauth2_http/java/com/google/auth/oauth2/DefaultPKCEProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
/* | ||
* Copyright 2023, Google Inc. All rights reserved. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
* modification, are permitted provided that the following conditions are | ||
* met: | ||
* | ||
* * Redistributions of source code must retain the above copyright | ||
* notice, this list of conditions and the following disclaimer. | ||
* * Redistributions in binary form must reproduce the above | ||
* copyright notice, this list of conditions and the following disclaimer | ||
* in the documentation and/or other materials provided with the | ||
* distribution. | ||
* | ||
* * Neither the name of Google Inc. nor the names of its | ||
* contributors may be used to endorse or promote products derived from | ||
* this software without specific prior written permission. | ||
* | ||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
*/ | ||
|
||
package com.google.auth.oauth2; | ||
|
||
import java.security.MessageDigest; | ||
import java.security.NoSuchAlgorithmException; | ||
import java.security.SecureRandom; | ||
import java.util.Base64; | ||
|
||
public class DefaultPKCEProvider implements PKCEProvider { | ||
private String codeVerifier; | ||
private CodeChallenge codeChallenge; | ||
private static final int MAX_CODE_VERIFIER_LENGTH = 127; | ||
|
||
private class CodeChallenge { | ||
private String codeChallenge; | ||
private String codeChallengeMethod; | ||
|
||
CodeChallenge(String codeVerifier) { | ||
try { | ||
byte[] bytes = codeVerifier.getBytes(); | ||
MessageDigest md = MessageDigest.getInstance("SHA-256"); | ||
md.update(bytes); | ||
|
||
byte[] digest = md.digest(); | ||
|
||
this.codeChallenge = Base64.getUrlEncoder().encodeToString(digest); | ||
this.codeChallengeMethod = "S256"; | ||
} catch (NoSuchAlgorithmException e) { | ||
this.codeChallenge = codeVerifier; | ||
this.codeChallengeMethod = "plain"; | ||
} | ||
} | ||
|
||
public String getCodeChallenge() { | ||
return codeChallenge; | ||
} | ||
|
||
public String getCodeChallengeMethod() { | ||
return codeChallengeMethod; | ||
} | ||
} | ||
|
||
private String createCodeVerifier() { | ||
SecureRandom sr = new SecureRandom(); | ||
byte[] code = new byte[MAX_CODE_VERIFIER_LENGTH]; | ||
sr.nextBytes(code); | ||
return Base64.getUrlEncoder().encodeToString(code); | ||
} | ||
|
||
private CodeChallenge createCodeChallenge(String codeVerifier) { | ||
return new DefaultPKCEProvider.CodeChallenge(codeVerifier); | ||
} | ||
|
||
public DefaultPKCEProvider() { | ||
this.codeVerifier = createCodeVerifier(); | ||
this.codeChallenge = createCodeChallenge(this.codeVerifier); | ||
} | ||
|
||
@Override | ||
public String getCodeVerifier() { | ||
return codeVerifier; | ||
} | ||
|
||
@Override | ||
public String getCodeChallenge() { | ||
return codeChallenge.getCodeChallenge(); | ||
} | ||
|
||
@Override | ||
public String getCodeChallengeMethod() { | ||
return codeChallenge.getCodeChallengeMethod(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
/* | ||
* Copyright 2023, Google Inc. All rights reserved. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
* modification, are permitted provided that the following conditions are | ||
* met: | ||
* | ||
* * Redistributions of source code must retain the above copyright | ||
* notice, this list of conditions and the following disclaimer. | ||
* * Redistributions in binary form must reproduce the above | ||
* copyright notice, this list of conditions and the following disclaimer | ||
* in the documentation and/or other materials provided with the | ||
* distribution. | ||
* | ||
* * Neither the name of Google Inc. nor the names of its | ||
* contributors may be used to endorse or promote products derived from | ||
* this software without specific prior written permission. | ||
* | ||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
*/ | ||
|
||
package com.google.auth.oauth2; | ||
|
||
public interface PKCEProvider { | ||
/** | ||
* Get the code_challenge parameter used in PKCE. | ||
* | ||
* @return The code_challenge String. | ||
*/ | ||
String getCodeChallenge(); | ||
|
||
/** | ||
* Get the code_challenge_method parameter used in PKCE. | ||
* | ||
* <p>Currently possible values are: S256,plain | ||
* | ||
* @return The code_challenge_method String. | ||
*/ | ||
String getCodeChallengeMethod(); | ||
/** | ||
* Get the code_verifier parameter used in PKCE. | ||
* | ||
* @return The code_verifier String. | ||
*/ | ||
String getCodeVerifier(); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
oauth2_http/javatests/com/google/auth/oauth2/DefaultPKCEProviderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* | ||
* Copyright 2023, Google Inc. All rights reserved. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
* modification, are permitted provided that the following conditions are | ||
* met: | ||
* | ||
* * Redistributions of source code must retain the above copyright | ||
* notice, this list of conditions and the following disclaimer. | ||
* * Redistributions in binary form must reproduce the above | ||
* copyright notice, this list of conditions and the following disclaimer | ||
* in the documentation and/or other materials provided with the | ||
* distribution. | ||
* | ||
* * Neither the name of Google Inc. nor the names of its | ||
* contributors may be used to endorse or promote products derived from | ||
* this software without specific prior written permission. | ||
* | ||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
*/ | ||
|
||
package com.google.auth.oauth2; | ||
|
||
import static org.junit.Assert.assertEquals; | ||
|
||
import java.security.MessageDigest; | ||
import java.security.NoSuchAlgorithmException; | ||
import java.util.Base64; | ||
import org.junit.Test; | ||
import org.junit.runner.RunWith; | ||
import org.junit.runners.JUnit4; | ||
|
||
@RunWith(JUnit4.class) | ||
public final class DefaultPKCEProviderTest { | ||
@Test | ||
public void testPkceExpected() throws NoSuchAlgorithmException { | ||
PKCEProvider pkce = new DefaultPKCEProvider(); | ||
|
||
byte[] bytes = pkce.getCodeVerifier().getBytes(); | ||
MessageDigest md = MessageDigest.getInstance("SHA-256"); | ||
md.update(bytes); | ||
|
||
byte[] digest = md.digest(); | ||
|
||
String expectedCodeChallenge = Base64.getUrlEncoder().encodeToString(digest); | ||
String expectedCodeChallengeMethod = "S256"; | ||
|
||
assertEquals(pkce.getCodeChallenge(), expectedCodeChallenge); | ||
assertEquals(pkce.getCodeChallengeMethod(), expectedCodeChallengeMethod); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters