Switched from Google OAuth2 to the built-in OAuth2 support

bbottema · bbottema · commit 9fa0451daf33 · 2023-01-05T13:27:12.000+01:00
diff --git a/modules/batch-module/pom.xml b/modules/batch-module/pom.xml
@@ -34,7 +34,7 @@
         <dependency>
             <groupId>org.simplejavamail</groupId>
             <artifactId>smtp-connection-pool</artifactId>
-            <version>2.1.0</version>
+            <version>2.1.1</version>
         </dependency>
     </dependencies>
 </project>
diff --git a/modules/batch-module/src/main/java/org/simplejavamail/internal/batchsupport/BatchSupport.java b/modules/batch-module/src/main/java/org/simplejavamail/internal/batchsupport/BatchSupport.java
@@ -8,9 +8,11 @@
 import org.jetbrains.annotations.Nullable;
 import org.simplejavamail.api.internal.batchsupport.LifecycleDelegatingTransport;
 import org.simplejavamail.api.mailer.config.OperationalConfig;
+import org.simplejavamail.api.mailer.config.TransportStrategy;
 import org.simplejavamail.internal.batchsupport.concurrent.NonJvmBlockingThreadPoolExecutor;
 import org.simplejavamail.internal.modules.BatchModule;
 import org.simplejavamail.internal.util.concurrent.AsyncOperationHelper;
+import org.simplejavamail.smtpconnectionpool.SmtpConnectionPool;
 import org.simplejavamail.smtpconnectionpool.SmtpConnectionPoolClustered;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -93,6 +95,7 @@ private void ensureClusterInitialized(@NotNull OperationalConfig operationalConf
 	public LifecycleDelegatingTransport acquireTransport(@NotNull final UUID clusterKey, @NotNull final Session session, boolean stickySession) {
 		try {
 			requireNonNull(smtpConnectionPool, "Connection pool used before it was initialized. This shouldn't be possible.");
+			checkConfigureOAuth2Token(session);
 			final PoolableObject<Transport> pooledTransport = stickySession
 					? smtpConnectionPool.claimResourceFromPool(new ResourceClusterAndPoolKey<>(clusterKey, session))
 					: smtpConnectionPool.claimResourceFromCluster(clusterKey);
@@ -102,6 +105,15 @@ public LifecycleDelegatingTransport acquireTransport(@NotNull final UUID cluster
 		}
 	}
 
+	// since the SMTP connection pool doesn't know about Simple Java Mail,
+	// it won't know where to look for the OAUTH2 token unless we copy the property
+	private void checkConfigureOAuth2Token(Session session) {
+		if (session.getProperties().containsKey(TransportStrategy.OAUTH2_TOKEN_PROPERTY)) {
+			session.getProperties().setProperty(SmtpConnectionPool.OAUTH2_TOKEN_PROPERTY,
+					session.getProperties().getProperty(TransportStrategy.OAUTH2_TOKEN_PROPERTY));
+		}
+	}
+
 	/**
 	 * @see BatchModule#shutdownConnectionPools(Session)
 	 */
diff --git a/modules/core-module/src/main/java/org/simplejavamail/api/mailer/MailerRegularBuilder.java b/modules/core-module/src/main/java/org/simplejavamail/api/mailer/MailerRegularBuilder.java
@@ -48,17 +48,6 @@ public interface MailerRegularBuilder<T extends MailerRegularBuilder<?>> extends
 	 */
 	T withSMTPServer(@Nullable String host, @Nullable Integer port, @Nullable String username, @Nullable String password);
 
-	/**
-	 * Delegates to {@link #withSMTPServerHost(String)}, {@link #withSMTPServerPort(Integer)}, {@link #withSMTPServerUsername(String)} and {@link
-	 * #withSMTPOAuth2Token(String)}.
-	 *
-	 * @param host Optional host that defaults to pre-configured property if left empty.
-	 * @param port Optional port number that defaults to pre-configured property if left empty.
-	 * @param username Optional username that defaults to pre-configured property if left empty.
-	 * @param oauth2Token Optional oauth2Token that defaults to pre-configured property if left empty.
-	 */
-	T withSMTPServerOAuth2(@Nullable String host, @Nullable Integer port, @Nullable String username, @Nullable String oauth2Token);
-	
 	/**
 	 * Delegates to {@link #withSMTPServerHost(String)}, {@link #withSMTPServerPort(Integer)} and {@link #withSMTPServerUsername(String)}.
 	 *
@@ -111,14 +100,6 @@ public interface MailerRegularBuilder<T extends MailerRegularBuilder<?>> extends
 	@Cli.ExcludeApi(reason = "API is a subset of another API method")
 	T withSMTPServerPassword(@Nullable String password);
 
-	/**
-	 * Sets the optional OAuth2 token. Will default to pre-configured property if left empty.
-	 *
-	 * @param oauth2Token Optional oauth2 token that defaults to pre-configured property if left empty.
-	 */
-	@Cli.ExcludeApi(reason = "API is a subset of another API method")
-	T withSMTPOAuth2Token(@Nullable String oauth2Token);
-
 	/**
 	 * Configures the session with the right property to use your own factory for obtaining SSL connections.
 	 * <p>
diff --git a/modules/core-module/src/main/java/org/simplejavamail/api/mailer/config/ServerConfig.java b/modules/core-module/src/main/java/org/simplejavamail/api/mailer/config/ServerConfig.java
@@ -10,7 +10,6 @@ public interface ServerConfig {
 	@NotNull Integer getPort();
 	@Nullable String getUsername();
 	@Nullable String getPassword();
-	@Nullable String getOAuth2Token();
 	@Nullable String getCustomSSLFactoryClass();
 	@Nullable SSLSocketFactory getCustomSSLFactoryInstance();
 }
diff --git a/modules/core-module/src/main/java/org/simplejavamail/api/mailer/config/TransportStrategy.java b/modules/core-module/src/main/java/org/simplejavamail/api/mailer/config/TransportStrategy.java
@@ -496,6 +496,7 @@ public String propertyNameCheckServerIdentity() {
 
 		/**
 		 * @see TransportStrategy#SMTP_OAUTH2
+		 * @see <a href="https://javaee.github.io/javamail/OAuth2">https://javaee.github.io/javamail/OAuth2</a>
 		 */
 		@Override
 		public Properties generateProperties() {
@@ -504,8 +505,7 @@ public Properties generateProperties() {
 			props.put("mail.smtp.starttls.enable", "true");
 			props.put("mail.smtp.starttls.required", "true");
 
-			props.put("mail.smtp.sasl.enable", "true");
-			props.put("mail.smtp.sasl.mechanisms", "XOAUTH2");
+			props.put("mail.smtp.auth.mechanisms", "XOAUTH2");
 			return props;
 		}
 
@@ -626,7 +626,8 @@ public String propertyNameCheckServerIdentity() {
 	 */
 	private static final String TRANSPORT_STRATEGY_MARKER = "simplejavamail.transportstrategy";
 
-	public static final String OAUTH2_TOKEN_PROPERTY = "mail.imaps.sasl.mechanisms.oauth2.oauthToken";
+	// FIXME is this still the right place?
+	public static final String OAUTH2_TOKEN_PROPERTY = "simplejavamail.oauth2.token";
 	
 	/**
 	 * For internal use only.
diff --git a/modules/core-module/src/main/java/org/simplejavamail/config/ConfigLoader.java b/modules/core-module/src/main/java/org/simplejavamail/config/ConfigLoader.java
@@ -35,7 +35,6 @@
  * <li>simplejavamail.smtp.port</li>
  * <li>simplejavamail.smtp.username</li>
  * <li>simplejavamail.smtp.password</li>
- * <li>simplejavamail.smtp.oauth2token</li>
  * <li>simplejavamail.disable.all.clientvalidation</li>
  * <li>simplejavamail.custom.sslfactory.class</li>
  * <li>simplejavamail.proxy.host</li>
@@ -129,7 +128,6 @@ public enum Property {
 		SMTP_PORT("simplejavamail.smtp.port"),
 		SMTP_USERNAME("simplejavamail.smtp.username"),
 		SMTP_PASSWORD("simplejavamail.smtp.password"),
-		SMTP_OAUTH2_TOKEN("simplejavamail.smtp.oauth2token"),
 		DISABLE_ALL_CLIENTVALIDATION("simplejavamail.disable.all.clientvalidation"),
 		CUSTOM_SSLFACTORY_CLASS("simplejavamail.custom.sslfactory.class"),
 		PROXY_HOST("simplejavamail.proxy.host"),
diff --git a/modules/core-test-module/src/main/java/demo/DemoAppBase.java b/modules/core-test-module/src/main/java/demo/DemoAppBase.java
@@ -13,9 +13,9 @@ public class DemoAppBase {
 
 	static final Logger LOGGER = LoggerFactory.getLogger(DemoAppBase.class);
 	
-	static final String YOUR_GMAIL_ADDRESS = "yourname@gmail.com";
+	static final String YOUR_GMAIL_ADDRESS = "your_gmail_user@gmail.com";
 	
-	// if you have 2-factor login turned on, you need to generate a once-per app password
+	// if you have 2-factor login turned on, you need to generate a once-per app password:
 	// https://security.google.com/settings/security/apppasswords
 	private static final String YOUR_GMAIL_PASSWORD = "<your password>";
 
diff --git a/modules/simple-java-mail/pom.xml b/modules/simple-java-mail/pom.xml
@@ -31,12 +31,6 @@
             <version>${project.version}</version>
             <scope>compile</scope>
         </dependency>
-        <dependency>
-            <groupId>org.simplejavamail</groupId>
-            <artifactId>google-oauth2-provider</artifactId>
-            <version>1.0.1</version>
-            <scope>compile</scope>
-        </dependency>
 
         <!-- optional support modules -->
         <dependency>
diff --git a/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/MailerException.java b/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/MailerException.java
@@ -10,9 +10,7 @@ class MailerException extends MailException {
 
 	static final String ERROR_READING_SMIME_FROM_INPUTSTREAM = "Was unable to read S/MIME data from input stream";
 	static final String ERROR_READING_FROM_FILE = "Error reading from file: %s";
-	static final String CANNOT_USE_BOTH_PASSWORD_AND_OAUTH2 = "Either authenticate using password or OAuth2 token, but not both";
-	static final String MISSING_OAUTH2_TOKEN = "TransportStrategy is OAUTH2 but no OAUTH2 token provided";
-	static final String WRONG_TRANSPORTSTRATEGY_FOR_OAUTH2_TOKEN = "OAUTH2 token provided, but TransportStrategy was %s instead of OAUTH2";
+	static final String MISSING_OAUTH2_TOKEN = "TransportStrategy is OAUTH2 but no OAUTH2 token provided as password";
 	static final String INVALID_PROXY_SLL_COMBINATION = "Proxy is not supported for SSL connections (this is a limitation by the underlying JavaMail framework)";
 	static final String ERROR_CONNECTING_SMTP_SERVER = "Was unable to connect to SMTP server";
 	static final String GENERIC_ERROR = "Failed to send email [%s], reason: Third party error";
diff --git a/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/MailerImpl.java b/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/MailerImpl.java
@@ -10,23 +10,21 @@
 import org.simplejavamail.api.mailer.Mailer;
 import org.simplejavamail.api.mailer.config.*;
 import org.simplejavamail.config.ConfigLoader;
-import org.simplejavamail.google.code.samples.oauth2.GoogleOAuth2Provider;
 import org.simplejavamail.internal.moduleloader.ModuleLoader;
 import org.simplejavamail.internal.util.concurrent.AsyncOperationHelper;
 import org.simplejavamail.mailer.MailerHelper;
 import org.simplejavamail.mailer.internal.util.SmtpAuthenticator;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.security.Security;
 import java.util.List;
 import java.util.Properties;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Future;
 import java.util.concurrent.atomic.AtomicInteger;
 
-import static java.lang.String.format;
 import static java.util.Optional.ofNullable;
+import static org.simplejavamail.api.mailer.config.TransportStrategy.SMTP_OAUTH2;
 import static org.simplejavamail.api.mailer.config.TransportStrategy.findStrategyForSession;
 import static org.simplejavamail.config.ConfigLoader.Property.EXTRA_PROPERTIES;
 import static org.simplejavamail.internal.util.ListUtil.getFirst;
@@ -166,26 +164,19 @@ public static Session createMailSession(@NotNull final ServerConfig serverConfig
 			props.putAll(ConfigLoader.getProperty(EXTRA_PROPERTIES));
 		}
 
-		if (serverConfig.getPassword() != null && serverConfig.getOAuth2Token() != null) {
-			throw new MailerException(MailerException.CANNOT_USE_BOTH_PASSWORD_AND_OAUTH2);
-		}
-
-		if (serverConfig.getOAuth2Token() != null && transportStrategy != TransportStrategy.SMTP_OAUTH2) {
-			throw new MailerException(format(MailerException.WRONG_TRANSPORTSTRATEGY_FOR_OAUTH2_TOKEN, transportStrategy));
-		}
-
-		if (transportStrategy == TransportStrategy.SMTP_OAUTH2 && serverConfig.getOAuth2Token() == null) {
+		if (transportStrategy == TransportStrategy.SMTP_OAUTH2 && serverConfig.getPassword() == null) {
 			throw new MailerException(MailerException.MISSING_OAUTH2_TOKEN);
 		}
 
 		if (serverConfig.getPassword() != null) {
-			props.put(transportStrategy.propertyNameAuthenticate(), "true");
-			return Session.getInstance(props, new SmtpAuthenticator(serverConfig));
-		} else if (serverConfig.getOAuth2Token() != null) {
-			props.put(transportStrategy.propertyNameAuthenticate(), "false");
-			props.put(TransportStrategy.OAUTH2_TOKEN_PROPERTY, serverConfig.getOAuth2Token());
-			Security.addProvider(new GoogleOAuth2Provider());
-			return Session.getInstance(props);
+			if (transportStrategy != SMTP_OAUTH2) {
+				props.put(transportStrategy.propertyNameAuthenticate(), "true");
+				return Session.getInstance(props, new SmtpAuthenticator(serverConfig));
+			} else {
+				// props.put(transportStrategy.propertyNameAuthenticate(), "false");
+				props.put(TransportStrategy.OAUTH2_TOKEN_PROPERTY, serverConfig.getPassword());
+				return Session.getInstance(props);
+			}
 		} else {
 			return Session.getInstance(props);
 		}
diff --git a/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/MailerRegularBuilderImpl.java b/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/MailerRegularBuilderImpl.java
@@ -42,11 +42,6 @@ public class MailerRegularBuilderImpl extends MailerGenericBuilderImpl<MailerReg
 	 */
 	private String password;
 
-	/**
-	 * @see #withSMTPOAuth2Token(String)
-	 */
-	private String oauth2Token;
-
 	/**
 	 * @see #withTransportStrategy(TransportStrategy)
 	 */
@@ -85,9 +80,6 @@ public MailerRegularBuilderImpl() {
 		if (hasProperty(SMTP_PASSWORD)) {
 			withSMTPServerPassword(verifyNonnullOrEmpty(ConfigLoader.getStringProperty(SMTP_PASSWORD)));
 		}
-		if (hasProperty(SMTP_OAUTH2_TOKEN)) {
-			withSMTPOAuth2Token(verifyNonnullOrEmpty(ConfigLoader.getStringProperty(SMTP_OAUTH2_TOKEN)));
-		}
 		this.transportStrategy = TransportStrategy.SMTP;
 		if (hasProperty(TRANSPORT_STRATEGY)) {
 			withTransportStrategy(verifyNonnullOrEmpty(ConfigLoader.getProperty(TRANSPORT_STRATEGY)));
@@ -117,17 +109,6 @@ public MailerRegularBuilderImpl withSMTPServer(@Nullable final String host, @Nul
 				.withSMTPServerPassword(emptyAsNull(password));
 	}
 
-	/**
-	 * @see MailerRegularBuilder#withSMTPServerOAuth2(String, Integer, String, String)
-	 */
-	@Override
-	public MailerRegularBuilderImpl withSMTPServerOAuth2(@Nullable final String host, @Nullable final Integer port, @Nullable final String username, @Nullable final String oauth2Token) {
-		return withSMTPServerHost(host)
-				.withSMTPServerPort(port)
-				.withSMTPServerUsername(emptyAsNull(username))
-				.withSMTPOAuth2Token(emptyAsNull(oauth2Token));
-	}
-	
 	/**
 	 * @see MailerRegularBuilder#withSMTPServer(String, Integer, String)
 	 */
@@ -183,15 +164,6 @@ public MailerRegularBuilderImpl withSMTPServerPassword(@Nullable final String pa
 		return this;
 	}
 
-	/**
-	 * @see MailerRegularBuilder#withSMTPOAuth2Token(String)
-	 */
-	@Override
-	public MailerRegularBuilderImpl withSMTPOAuth2Token(@Nullable final String oauth2Token) {
-		this.oauth2Token = oauth2Token;
-		return this;
-	}
-
 	/**
 	 * @see MailerRegularBuilder#withCustomSSLFactoryClass(String)
 	 */
@@ -224,7 +196,7 @@ public Mailer buildMailer() {
 	ServerConfig buildServerConfig() {
 		vallidateServerConfig();
 		final int serverPort = ofNullable(port).orElse(transportStrategy.getDefaultServerPort());
-		return new ServerConfigImpl(verifyNonnullOrEmpty(getHost()), serverPort, username, password, oauth2Token, customSSLFactory, customSSLFactoryInstance);
+		return new ServerConfigImpl(verifyNonnullOrEmpty(getHost()), serverPort, username, password, customSSLFactory, customSSLFactoryInstance);
 	}
 
 	private void vallidateServerConfig() {
diff --git a/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/ServerConfigImpl.java b/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/ServerConfigImpl.java
@@ -17,17 +17,15 @@ class ServerConfigImpl implements ServerConfig {
 	@NotNull private final Integer port;
 	@Nullable private final String username;
 	@Nullable private final String password;
-	@Nullable private final String oauth2Token;
 	@Nullable private final String customSSLFactoryClass;
 	@Nullable private final SSLSocketFactory customSSLFactoryInstance;
 
-	ServerConfigImpl(@NotNull final String host, @NotNull final Integer port, @Nullable final String username, @Nullable final String password, @Nullable final String oauth2Token,
+	ServerConfigImpl(@NotNull final String host, @NotNull final Integer port, @Nullable final String username, @Nullable final String password,
 					 @Nullable final String customSSLFactoryClass, final @Nullable SSLSocketFactory customSSLFactoryInstance) {
 		this.host = host;
 		this.port = port;
 		this.username = username;
 		this.password = password;
-		this.oauth2Token = oauth2Token;
 		this.customSSLFactoryClass = customSSLFactoryClass;
 		this.customSSLFactoryInstance = customSSLFactoryInstance;
 
@@ -84,15 +82,6 @@ public String getPassword() {
 		return password;
 	}
 
-	/**
-	 * @see ServerConfig#getOAuth2Token()
-	 */
-	@Override
-	@Nullable
-	public String getOAuth2Token() {
-		return oauth2Token;
-	}
-
 	/**
 	 * @see ServerConfig#getCustomSSLFactoryClass()
 	 */
diff --git a/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/util/TransportConnectionHelper.java b/modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/util/TransportConnectionHelper.java
@@ -3,23 +3,26 @@
 import jakarta.mail.MessagingException;
 import jakarta.mail.Session;
 import jakarta.mail.Transport;
+import lombok.val;
 import org.simplejavamail.api.mailer.config.TransportStrategy;
 
-import static org.simplejavamail.api.mailer.config.TransportStrategy.SMTP_TLS;
-
 /**
  * @see #connectTransport(Transport, Session)
  */
 public class TransportConnectionHelper {
 
     /**
      * To connect using OAuth2 authentication, we need to connect slightly differently as we can't use only Session properties and the traditional Authenticator class for
-     * providing password. Instead, <em>mail.smtp.auth</em> is set to {@code false} and Google's OAuth2 Security Provider should take over, but this is only triggered succesfully if we
-     * provide an empty non-null password, and that is only possible using the alternative {@link Transport#connect(String, String)}.
+     * providing password. Instead, <em>mail.smtp.auth.mechanisms</em> is set to {@code "XOAUTH2"} and the built-in OAuth2 Security Provider should take over and use the
+     * token as the password, and that is only possible using the alternative {@link Transport#connect(String, String)}.
+     *
+     * @see <a href="https://javaee.github.io/javamail/OAuth2">https://javaee.github.io/javamail/OAuth2</a>
      */
     public static void connectTransport(Transport transport, Session session) throws MessagingException {
         if (session.getProperties().containsKey(TransportStrategy.OAUTH2_TOKEN_PROPERTY)) {
-            transport.connect(session.getProperties().getProperty(SMTP_TLS.propertyNameUsername()), "");
+            val username = session.getProperties().getProperty(TransportStrategy.SMTP_TLS.propertyNameUsername());
+            val oauth2Token = session.getProperties().getProperty(TransportStrategy.OAUTH2_TOKEN_PROPERTY);
+            transport.connect(username, oauth2Token);
         } else {
             transport.connect();
         }
diff --git a/modules/simple-java-mail/src/test/java/demo/FullEmailDemoApp.java b/modules/simple-java-mail/src/test/java/demo/FullEmailDemoApp.java
diff --git a/modules/simple-java-mail/src/test/java/demo/OAuth2DemoApp.java b/modules/simple-java-mail/src/test/java/demo/OAuth2DemoApp.java
diff --git a/modules/simple-java-mail/src/test/java/demo/TestConnectionDemo.java b/modules/simple-java-mail/src/test/java/demo/TestConnectionDemo.java
diff --git a/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/internal/ServerConfigTest.java b/modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/internal/ServerConfigTest.java
diff --git a/modules/spring-module/src/main/java/org/simplejavamail/springsupport/SimpleJavaMailSpringSupport.java b/modules/spring-module/src/main/java/org/simplejavamail/springsupport/SimpleJavaMailSpringSupport.java

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ public interface ServerConfig {`
`10`	`10`	`@NotNull Integer getPort();`
`11`	`11`	`@Nullable String getUsername();`
`12`	`12`	`@Nullable String getPassword();`
`13`		`- @Nullable String getOAuth2Token();`
`14`	`13`	`@Nullable String getCustomSSLFactoryClass();`
`15`	`14`	`@Nullable SSLSocketFactory getCustomSSLFactoryInstance();`
`16`	`15`	`}`