feat: Add OAuth1 connection strategy support in ConnectionManager

management/connection.go

@@ -42,6 +42,8 @@ const (
 	ConnectionStrategyOIDC = "oidc"
 	// ConnectionStrategyOAuth2 constant.
 	ConnectionStrategyOAuth2 = "oauth2"
+	// ConnectionStrategyOAuth1 constant.
+	ConnectionStrategyOAuth1 = "oauth1"
 	// ConnectionStrategyAD constant.
 	ConnectionStrategyAD = "ad"
 	// ConnectionStrategyADFS constant.
@@ -382,6 +384,8 @@ func (c *Connection) UnmarshalJSON(b []byte) error {
 			v = &ConnectionOptionsSMS{}
 		case ConnectionStrategyOIDC:
 			v = &ConnectionOptionsOIDC{}
+		case ConnectionStrategyOAuth1:
+			v = &ConnectionOptionsOAuth1{}
 		case ConnectionStrategyOAuth2,
 			ConnectionStrategyDropbox,
 			ConnectionStrategyBitBucket,
@@ -1336,6 +1340,37 @@ func (c *ConnectionOptionsOAuth2) SetScopes(enable bool, scopes ...string) {
 	c.Scope = &scope
 }
 
+// ConnectionOptionsOAuth1 is used to configure an OAuth1 Connection.
+type ConnectionOptionsOAuth1 struct {
+	// ConsumerKey identifies the client to the service provider.
+	ConsumerKey *string `json:"consumer_key,omitempty"`
+
+	// ConsumerSecret is the secret used to establish ownership of the consumer key.
+	ConsumerSecret *string `json:"consumer_secret,omitempty"`
+
+	// RequestTokenURL is the URL used to obtain an unauthorized request token.
+	RequestTokenURL *string `json:"requestTokenURL,omitempty"`
+
+	// AccessTokenURL is the URL used to exchange a user-authorized request token for an access token.
+	AccessTokenURL *string `json:"accessTokenURL,omitempty"`
+
+	// UserAuthorizationURL is the URL used to obtain user authorization.
+	UserAuthorizationURL *string `json:"userAuthorizationURL,omitempty"`
+
+	// SessionKey is the session key for storing the request token.
+	SessionKey *string `json:"sessionKey,omitempty"`
+
+	// SignatureMethod is the signature method used to sign the request (default: 'HMAC-SHA1').
+	SignatureMethod *string `json:"signatureMethod,omitempty"`
+
+	// CustomHeaders specifies custom headers.
+	CustomHeaders *map[string]string `json:"customHeaders,omitempty"`
+
+	// Scripts contains scripts for the connection.
+	// Allowed keys are: "fetchUserProfile"
+	Scripts *map[string]string `json:"scripts,omitempty"`
+}
+
 // ConnectionOptionsAD is used to configure an AD Connection.
 type ConnectionOptionsAD struct {
 	StrategyVersion *int `json:"strategy_version,omitempty"`

management/connection_test.go

@@ -501,6 +501,24 @@ ZsUkLw2I7zI/dNlWdB8Xp7v+3w9sX5N3J/WuJ1KOO5m26kRlHQo7EzT3974g
 			DigestAlgorithm:    auth0.String("sha256"),
 		},
 	},
+	{
+		name: "OAuth1 Connection",
+		connection: Connection{
+			Name:     auth0.Stringf("Test-OAuth1-Connection-%d", time.Now().Unix()),
+			Strategy: auth0.String("oauth1"),
+		},
+		options: &ConnectionOptionsOAuth1{
+			ConsumerKey:          auth0.String("test-consumer-key"),
+			ConsumerSecret:       auth0.String("test-consumer-secret"),
+			RequestTokenURL:      auth0.String("https://api.twitter.com/oauth/request_token"),
+			AccessTokenURL:       auth0.String("https://api.twitter.com/oauth/access_token"),
+			UserAuthorizationURL: auth0.String("https://api.twitter.com/oauth/authorize"),
+			SignatureMethod:      auth0.String("HMAC-SHA1"),
+			Scripts: &map[string]string{
+				"fetchUserProfile": "function(token, tokenSecret, ctx, cb) { return cb(null, {}); }",
+			},
+		},
+	},
 }
 
 type connectionTestCase struct {
@@ -949,8 +967,9 @@ func TestConnectionManager_Update(t *testing.T) {
 				testCase.connection.GetStrategy() == "okta" ||
 				testCase.connection.GetStrategy() == "adfs" ||
 				testCase.connection.GetStrategy() == "waad" ||
-				testCase.connection.GetStrategy() == "pingfederate" {
-				t.Skip("Skipping because we can't create an oidc, okta, samlp, adfs, waad, or pingfederate connection with no options")
+				testCase.connection.GetStrategy() == "pingfederate" ||
+				testCase.connection.GetStrategy() == "oauth1" {
+				t.Skip("Skipping because we can't create an oidc, okta, samlp, adfs, waad, pingfederate, or oauth1 connection with no options")
 			}
 
 			configureHTTPTestRecordings(t)
@@ -1555,6 +1574,83 @@ func getStrategyVersion(strategy string, options interface{}) int {
 	}
 }
 
+func TestOAuth1Connection_MarshalJSON(t *testing.T) {
+	for connection, expected := range map[*ConnectionOptionsOAuth1]string{
+		{
+			ConsumerKey:          auth0.String("test-key"),
+			ConsumerSecret:       auth0.String("test-secret"),
+			RequestTokenURL:      auth0.String("https://example.com/oauth/request_token"),
+			AccessTokenURL:       auth0.String("https://example.com/oauth/access_token"),
+			UserAuthorizationURL: auth0.String("https://example.com/oauth/authorize"),
+		}: `{"consumer_key":"test-key","consumer_secret":"test-secret","requestTokenURL":"https://example.com/oauth/request_token","accessTokenURL":"https://example.com/oauth/access_token","userAuthorizationURL":"https://example.com/oauth/authorize"}`,
+		{
+			ConsumerKey:          auth0.String("test-key"),
+			ConsumerSecret:       auth0.String("test-secret"),
+			RequestTokenURL:      auth0.String("https://example.com/oauth/request_token"),
+			AccessTokenURL:       auth0.String("https://example.com/oauth/access_token"),
+			UserAuthorizationURL: auth0.String("https://example.com/oauth/authorize"),
+			SessionKey:           auth0.String("oauth_token"),
+			SignatureMethod:      auth0.String("HMAC-SHA1"),
+		}: `{"consumer_key":"test-key","consumer_secret":"test-secret","requestTokenURL":"https://example.com/oauth/request_token","accessTokenURL":"https://example.com/oauth/access_token","userAuthorizationURL":"https://example.com/oauth/authorize","sessionKey":"oauth_token","signatureMethod":"HMAC-SHA1"}`,
+		{
+			ConsumerKey:          auth0.String("test-key"),
+			ConsumerSecret:       auth0.String("test-secret"),
+			RequestTokenURL:      auth0.String("https://example.com/oauth/request_token"),
+			AccessTokenURL:       auth0.String("https://example.com/oauth/access_token"),
+			UserAuthorizationURL: auth0.String("https://example.com/oauth/authorize"),
+			CustomHeaders: &map[string]string{
+				"X-Custom-Header": "custom-value",
+			},
+			Scripts: &map[string]string{
+				"fetchUserProfile": "function(token, tokenSecret, ctx, cb) { cb(null, {}); }",
+			},
+		}: `{"consumer_key":"test-key","consumer_secret":"test-secret","requestTokenURL":"https://example.com/oauth/request_token","accessTokenURL":"https://example.com/oauth/access_token","userAuthorizationURL":"https://example.com/oauth/authorize","customHeaders":{"X-Custom-Header":"custom-value"},"scripts":{"fetchUserProfile":"function(token, tokenSecret, ctx, cb) { cb(null, {}); }"}}`,
+	} {
+		payload, err := json.Marshal(connection)
+		assert.NoError(t, err)
+		assert.JSONEq(t, expected, string(payload))
+	}
+}
+
+func TestOAuth1Connection_UnmarshalJSON(t *testing.T) {
+	for expectedAsString, expected := range map[string]*ConnectionOptionsOAuth1{
+		`{"consumer_key":"test-key","consumer_secret":"test-secret","requestTokenURL":"https://example.com/oauth/request_token","accessTokenURL":"https://example.com/oauth/access_token","userAuthorizationURL":"https://example.com/oauth/authorize"}`: {
+			ConsumerKey:          auth0.String("test-key"),
+			ConsumerSecret:       auth0.String("test-secret"),
+			RequestTokenURL:      auth0.String("https://example.com/oauth/request_token"),
+			AccessTokenURL:       auth0.String("https://example.com/oauth/access_token"),
+			UserAuthorizationURL: auth0.String("https://example.com/oauth/authorize"),
+		},
+		`{"consumer_key":"test-key","consumer_secret":"test-secret","requestTokenURL":"https://example.com/oauth/request_token","accessTokenURL":"https://example.com/oauth/access_token","userAuthorizationURL":"https://example.com/oauth/authorize","sessionKey":"oauth_token","signatureMethod":"HMAC-SHA1"}`: {
+			ConsumerKey:          auth0.String("test-key"),
+			ConsumerSecret:       auth0.String("test-secret"),
+			RequestTokenURL:      auth0.String("https://example.com/oauth/request_token"),
+			AccessTokenURL:       auth0.String("https://example.com/oauth/access_token"),
+			UserAuthorizationURL: auth0.String("https://example.com/oauth/authorize"),
+			SessionKey:           auth0.String("oauth_token"),
+			SignatureMethod:      auth0.String("HMAC-SHA1"),
+		},
+		`{"consumer_key":"test-key","consumer_secret":"test-secret","requestTokenURL":"https://example.com/oauth/request_token","accessTokenURL":"https://example.com/oauth/access_token","userAuthorizationURL":"https://example.com/oauth/authorize","customHeaders":{"X-Custom-Header":"custom-value"},"scripts":{"fetchUserProfile":"function(token, tokenSecret, ctx, cb) { cb(null, {}); }"}}`: {
+			ConsumerKey:          auth0.String("test-key"),
+			ConsumerSecret:       auth0.String("test-secret"),
+			RequestTokenURL:      auth0.String("https://example.com/oauth/request_token"),
+			AccessTokenURL:       auth0.String("https://example.com/oauth/access_token"),
+			UserAuthorizationURL: auth0.String("https://example.com/oauth/authorize"),
+			CustomHeaders: &map[string]string{
+				"X-Custom-Header": "custom-value",
+			},
+			Scripts: &map[string]string{
+				"fetchUserProfile": "function(token, tokenSecret, ctx, cb) { cb(null, {}); }",
+			},
+		},
+	} {
+		var actual *ConnectionOptionsOAuth1
+		err := json.Unmarshal([]byte(expectedAsString), &actual)
+		assert.NoError(t, err)
+		assert.Equal(t, expected, actual)
+	}
+}
+
 func getEnabledClientIDs(t *testing.T, connectionID string) []string {
 	t.Helper()