-
Notifications
You must be signed in to change notification settings - Fork 839
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.
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
Add SCRAM-SHA-256 support #842
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
dc9421f
Add SCRAM-SHA-256 support
ahachete 5dc70b4
Prepare Java8-only code to be excluded for jre<=8
ahachete e0f6337
On HEAD all testing connections will use SCRAM
ahachete 7894505
Better error message for drivers w/o SCRAM support
ahachete a32357a
added configuration for shaded jar
davecramer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
166 changes: 166 additions & 0 deletions
166
pgjdbc/src/main/java/org/postgresql/jre8/sasl/ScramAuthenticator.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,166 @@ | ||
| /* | ||
| * Copyright (c) 2017, PostgreSQL Global Development Group | ||
| * See the LICENSE file in the project root for more information. | ||
| */ | ||
|
|
||
|
|
||
| package org.postgresql.jre8.sasl; | ||
|
|
||
| import org.postgresql.core.PGStream; | ||
| import org.postgresql.util.GT; | ||
| import org.postgresql.util.PSQLException; | ||
| import org.postgresql.util.PSQLState; | ||
|
|
||
| import com.ongres.scram.client.ScramClient; | ||
| import com.ongres.scram.client.ScramSession; | ||
| import com.ongres.scram.common.exception.ScramException; | ||
| import com.ongres.scram.common.exception.ScramInvalidServerSignatureException; | ||
| import com.ongres.scram.common.exception.ScramParseException; | ||
| import com.ongres.scram.common.exception.ScramServerErrorException; | ||
| import com.ongres.scram.common.stringprep.StringPreparations; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| public class ScramAuthenticator { | ||
| private static final Logger LOGGER = Logger.getLogger(ScramAuthenticator.class.getName()); | ||
|
|
||
| private final String user; | ||
| private final String password; | ||
| private final PGStream pgStream; | ||
| private ScramClient scramClient; | ||
| private ScramSession scramSession; | ||
| private ScramSession.ServerFirstProcessor serverFirstProcessor; | ||
| private ScramSession.ClientFinalProcessor clientFinalProcessor; | ||
|
|
||
| @FunctionalInterface | ||
| private interface BodySender { | ||
| void sendBody(PGStream pgStream) throws IOException; | ||
| } | ||
|
|
||
| private void sendAuthenticationMessage(int bodyLength, BodySender bodySender) | ||
| throws IOException { | ||
| pgStream.sendChar('p'); | ||
| pgStream.sendInteger4(Integer.BYTES + bodyLength); | ||
| bodySender.sendBody(pgStream); | ||
| pgStream.flush(); | ||
| } | ||
|
|
||
| public ScramAuthenticator(String user, String password, PGStream pgStream) { | ||
| this.user = user; | ||
| this.password = password; | ||
| this.pgStream = pgStream; | ||
| } | ||
|
|
||
| public void processServerMechanismsAndInit() throws IOException, PSQLException { | ||
| List<String> mechanisms = new ArrayList<>(); | ||
| do { | ||
| mechanisms.add(pgStream.receiveString()); | ||
| } while (pgStream.peekChar() != 0); | ||
| int c = pgStream.receiveChar(); | ||
| assert c == 0; | ||
| if (mechanisms.size() < 1) { | ||
| throw new PSQLException( | ||
| GT.tr("No SCRAM mechanism(s) advertised by the server"), | ||
| PSQLState.CONNECTION_REJECTED | ||
| ); | ||
| } | ||
|
|
||
| try { | ||
| scramClient = ScramClient | ||
| .channelBinding(ScramClient.ChannelBinding.NO) | ||
| .stringPreparation(StringPreparations.NO_PREPARATION) | ||
| .selectMechanismBasedOnServerAdvertised(mechanisms.toArray(new String[]{})) | ||
| .setup(); | ||
| } catch (IllegalArgumentException e) { | ||
| throw new PSQLException( | ||
| GT.tr("Invalid or unsupported by client SCRAM mechanisms", e), | ||
| PSQLState.CONNECTION_REJECTED | ||
| ); | ||
| } | ||
| LOGGER.log(Level.FINEST, " Using SCRAM mechanism {0}", scramClient.getScramMechanism().getName()); | ||
|
|
||
| scramSession = | ||
| scramClient.scramSession("*"); // Real username is ignored by server, uses startup one | ||
| } | ||
|
|
||
| public void sendScramClientFirstMessage() throws IOException { | ||
| String clientFirstMessage = scramSession.clientFirstMessage(); | ||
| LOGGER.log(Level.FINEST, " FE=> SASLInitialResponse( {0} )", clientFirstMessage); | ||
|
|
||
| String scramMechanismName = scramClient.getScramMechanism().getName(); | ||
| byte[] scramMechanismNameBytes = scramMechanismName.getBytes(StandardCharsets.UTF_8); | ||
| byte[] clientFirstMessageBytes = clientFirstMessage.getBytes(StandardCharsets.UTF_8); | ||
| sendAuthenticationMessage( | ||
| (scramMechanismNameBytes.length + 1) + 4 + clientFirstMessageBytes.length, | ||
| s -> { | ||
| s.send(scramMechanismNameBytes); | ||
| s.sendChar(0); // List terminated in '\0' | ||
| s.sendInteger4(clientFirstMessageBytes.length); | ||
| s.send(clientFirstMessageBytes); | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| public void processServerFirstMessage(int length) throws IOException, PSQLException { | ||
| String serverFirstMessage = pgStream.receiveString(length); | ||
| LOGGER.log(Level.FINEST, " <=BE AuthenticationSASLContinue( {0} )", serverFirstMessage); | ||
|
|
||
| try { | ||
| serverFirstProcessor = scramSession.receiveServerFirstMessage(serverFirstMessage); | ||
| } catch (ScramException e) { | ||
| throw new PSQLException( | ||
| GT.tr("Invalid server-first-message: {0}", serverFirstMessage), | ||
| PSQLState.CONNECTION_REJECTED, | ||
| e | ||
| ); | ||
| } | ||
| LOGGER.log(Level.FINEST, | ||
| " <=BE AuthenticationSASLContinue(salt={0}, iterations={1})", | ||
| new Object[] { serverFirstProcessor.getSalt(), serverFirstProcessor.getIteration() } | ||
| ); | ||
|
|
||
| clientFinalProcessor = serverFirstProcessor.clientFinalProcessor(password); | ||
|
|
||
| String clientFinalMessage = clientFinalProcessor.clientFinalMessage(); | ||
| LOGGER.log(Level.FINEST, " FE=> SASLResponse( {0} )", clientFinalMessage); | ||
|
|
||
| byte[] clientFinalMessageBytes = clientFinalMessage.getBytes(StandardCharsets.UTF_8); | ||
| sendAuthenticationMessage( | ||
| clientFinalMessageBytes.length, | ||
| s -> s.send(clientFinalMessageBytes) | ||
| ); | ||
| } | ||
|
|
||
| public void verifyServerSignature(int length) throws IOException, PSQLException { | ||
| String serverFinalMessage = pgStream.receiveString(length); | ||
| LOGGER.log(Level.FINEST, " <=BE AuthenticationSASLFinal( {0} )", serverFinalMessage); | ||
|
|
||
| try { | ||
| clientFinalProcessor.receiveServerFinalMessage(serverFinalMessage); | ||
| } catch (ScramParseException e) { | ||
| throw new PSQLException( | ||
| GT.tr("Invalid server-final-message: {0}", serverFinalMessage), | ||
| PSQLState.CONNECTION_REJECTED, | ||
| e | ||
| ); | ||
| } catch (ScramServerErrorException e) { | ||
| throw new PSQLException( | ||
| GT.tr("SCRAM authentication failed, server returned error: {0}", | ||
| e.getError().getErrorMessage()), | ||
| PSQLState.CONNECTION_REJECTED, | ||
| e | ||
| ); | ||
| } catch (ScramInvalidServerSignatureException e) { | ||
| throw new PSQLException( | ||
| GT.tr("Invalid server SCRAM signature"), | ||
| PSQLState.CONNECTION_REJECTED, | ||
| e | ||
| ); | ||
| } | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will this be a
betadependency?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That bothers me a bit as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was planning on bumping it to 1.0.0 when it is well tested and ready to be integrated. So if you feel this is OK, I will proceed and release 1.0.0 and update the PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ahachete well, it will never be tested if it's not included in pgjdbc, so is a chicken-egg problem, it's your code, so you better know if it is well tested.
I'm Ok if it's released as a Beta feature, mark it as such in release notes and if everything goes fine, bumping it to 1.0.0 and update it for the next release cycle.