Skip to content

fix: Java doc for DefaultPKCEProvider.java #1148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clundin25 merged 4 commits into from
Feb 13, 2023
Merged

fix: Java doc for DefaultPKCEProvider.java #1148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1bce4b8
fix: Java doc for DefaultPKCEProvider.java
clundin25 Feb 7, 2023
1d065fc
Correct document link.
clundin25 Feb 8, 2023
7e5c290
Test all methods as NULL.
clundin25 Feb 13, 2023
730c8fc
Merge branch 'main' into pkce-docs
clundin25 Feb 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 35 additions & 29 deletions oauth2_http/java/com/google/auth/oauth2/DefaultPKCEProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,40 +36,16 @@
import java.security.SecureRandom;
import java.util.Base64;

/**
* Implements PKCE using only the Java standard library. See https://www.rfc-editor.org/rfc/rfc7636.
*
* <p>https://developers.google.com/identity/protocols/oauth2/native-app#step1-code-verifier.
*/
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];
Expand Down Expand Up @@ -100,4 +76,34 @@ public String getCodeChallenge() {
public String getCodeChallengeMethod() {
return codeChallenge.getCodeChallengeMethod();
}

/** Class representing the Code Challenge derived from a Code Verifier string. */
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;
}
}
}
62 changes: 60 additions & 2 deletions oauth2_http/javatests/com/google/auth/oauth2/UserAuthorizerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ public void revokeAuthorization_revokesAndClears() throws IOException {
}

@Test(expected = IllegalArgumentException.class)
public void illegalPKCEProvider() {
public void nullCodeVerifierPKCEProvider() {
PKCEProvider pkce =
new PKCEProvider() {
@Override
Expand All @@ -487,7 +487,36 @@ public String getCodeVerifier() {

@Override
public String getCodeChallengeMethod() {
return null;
return "dummy string";
}

@Override
public String getCodeChallenge() {
return "dummy string";
}
};

UserAuthorizer authorizer =
UserAuthorizer.newBuilder()
.setClientId(CLIENT_ID)
.setScopes(DUMMY_SCOPES)
.setTokenStore(new MemoryTokensStorage())
.setPKCEProvider(pkce)
.build();
}

@Test(expected = IllegalArgumentException.class)
public void nullCodeChallengePKCEProvider() {
PKCEProvider pkce =
new PKCEProvider() {
@Override
public String getCodeVerifier() {
return "dummy string";
}

@Override
public String getCodeChallengeMethod() {
return "dummy string";
}

@Override
Expand All @@ -504,4 +533,33 @@ public String getCodeChallenge() {
.setPKCEProvider(pkce)
.build();
}

@Test(expected = IllegalArgumentException.class)
public void nullCodeChallengeMethodPKCEProvider() {
PKCEProvider pkce =
new PKCEProvider() {
@Override
public String getCodeVerifier() {
return "dummy string";
}

@Override
public String getCodeChallengeMethod() {
return null;
}

@Override
public String getCodeChallenge() {
return "dummy string";
}
};

UserAuthorizer authorizer =
UserAuthorizer.newBuilder()
.setClientId(CLIENT_ID)
.setScopes(DUMMY_SCOPES)
.setTokenStore(new MemoryTokensStorage())
.setPKCEProvider(pkce)
.build();
}
}