#12897 - add mastodon provider (#13293)

* added mastodon provider to oauth code

* changed go.mod and vendor/modules.txt to add updated goth

* vendored mastodon and new goth

* committing result of go mod tidy && go mod vendor

* added pic and mastodon to oauth models

* handled instance url

* applied lafriks suggestion

* Update web_src/js/index.js

Co-authored-by: techknowlogick <[email protected]>

Co-authored-by: techknowlogick <[email protected]>
Co-authored-by: Lauris BH <[email protected]>
Co-authored-by: techknowlogick <[email protected]>

Author: 3 people

go.sum

@@ -59,6 +59,11 @@ var OAuth2Providers = map[string]OAuth2Provider{
 		},
 	},
 	"yandex": {Name: "yandex", DisplayName: "Yandex", Image: "/img/auth/yandex.png"},
+	"mastodon": {Name: "mastodon", DisplayName: "Mastodon", Image: "/img/auth/mastodon.png",
+		CustomURLMapping: &oauth2.CustomURLMapping{
+			AuthURL: oauth2.GetDefaultAuthURL("mastodon"),
+		},
+	},
 }
 
 // OAuth2DefaultCustomURLMappings contains the map of default URL's for OAuth2 providers that are allowed to have custom urls
@@ -69,6 +74,7 @@ var OAuth2DefaultCustomURLMappings = map[string]*oauth2.CustomURLMapping{
 	"gitlab":    OAuth2Providers["gitlab"].CustomURLMapping,
 	"gitea":     OAuth2Providers["gitea"].CustomURLMapping,
 	"nextcloud": OAuth2Providers["nextcloud"].CustomURLMapping,
+	"mastodon":  OAuth2Providers["mastodon"].CustomURLMapping,
 }
 
 // GetActiveOAuth2ProviderLoginSources returns all actived LoginOAuth2 sources

models/oauth2.go

@@ -23,6 +23,7 @@ import (
 	"github.com/markbates/goth/providers/github"
 	"github.com/markbates/goth/providers/gitlab"
 	"github.com/markbates/goth/providers/google"
+	"github.com/markbates/goth/providers/mastodon"
 	"github.com/markbates/goth/providers/nextcloud"
 	"github.com/markbates/goth/providers/openidConnect"
 	"github.com/markbates/goth/providers/twitter"
@@ -213,6 +214,12 @@ func createProvider(providerName, providerType, clientID, clientSecret, openIDCo
 	case "yandex":
 		// See https://tech.yandex.com/passport/doc/dg/reference/response-docpage/
 		provider = yandex.New(clientID, clientSecret, callbackURL, "login:email", "login:info", "login:avatar")
+	case "mastodon":
+		instanceURL := mastodon.InstanceURL
+		if customURLMapping != nil && len(customURLMapping.AuthURL) > 0 {
+			instanceURL = customURLMapping.AuthURL
+		}
+		provider = mastodon.NewCustomisedURL(clientID, clientSecret, callbackURL, instanceURL)
 	}
 
 	// always set the name if provider is created so we can support multiple setups of 1 provider
@@ -249,6 +256,8 @@ func GetDefaultAuthURL(provider string) string {
 		return gitea.AuthURL
 	case "nextcloud":
 		return nextcloud.AuthURL
+	case "mastodon":
+		return mastodon.InstanceURL
 	}
 	return ""
 }

modules/auth/oauth2/oauth2.go

@@ -2208,6 +2208,7 @@ auths.tip.twitter = Go to https://dev.twitter.com/apps, create an application an
 auths.tip.discord = Register a new application on https://discordapp.com/developers/applications/me
 auths.tip.gitea = Register a new OAuth2 application. Guide can be found at https://docs.gitea.io/en-us/oauth2-provider/
 auths.tip.yandex = Create a new application at https://oauth.yandex.com/client/new. Select following permissions from the "Yandex.Passport API" section: "Access to email address", "Access to user avatar" and "Access to username, first name and surname, gender"
+auths.tip.mastodon = Input a custom instance URL for the mastodon instance you want to authenticate with (or use the default one)
 auths.edit = Edit Authentication Source
 auths.activated = This Authentication Source is Activated
 auths.new_success = The authentication '%s' has been added.

options/locale/locale_en-US.ini

@@ -119,6 +119,8 @@
 				<span>{{.i18n.Tr "admin.auths.tip.nextcloud"}}</span>
 				<li>Yandex</li>
 				<span>{{.i18n.Tr "admin.auths.tip.yandex"}}</span>
+        <li>Mastodon</li>
+        <span>{{.i18n.Tr "admin.auths.tip.mastodon"}}</span>
 			</div>
 		</div>
 	</div>

public/img/auth/mastodon.png

@@ -55,4 +55,4 @@
 			<input id="{{$key}}_email_url" value="{{$value.EmailURL}}" type="hidden" />
 		{{end}}
 	{{end}}
-</div>
+</div>

templates/admin/auth/new.tmpl

@@ -559,6 +559,7 @@ github.com/markbates/goth/providers/gitea
 github.com/markbates/goth/providers/github
 github.com/markbates/goth/providers/gitlab
 github.com/markbates/goth/providers/google
+github.com/markbates/goth/providers/mastodon
 github.com/markbates/goth/providers/nextcloud
 github.com/markbates/goth/providers/openidConnect
 github.com/markbates/goth/providers/twitter

templates/admin/auth/source/oauth.tmpl

@@ -1798,6 +1798,7 @@ function initAdmin() {
       case 'gitlab':
       case 'gitea':
       case 'nextcloud':
+      case 'mastodon':
         $('.oauth2_use_custom_url').show();
         break;
       case 'openidConnect':
@@ -1831,6 +1832,10 @@ function initAdmin() {
           $('.oauth2_token_url, .oauth2_auth_url, .oauth2_profile_url').show();
           $('#oauth2_email_url').val('');
           break;
+        case 'mastodon':
+          $('.oauth2_auth_url input').attr('required', 'required');
+          $('.oauth2_auth_url').show();
+          break;
       }
     }
   }