forked from pocketbase/pocketbase
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[pocketbase#979] added Kakao OAuth2 provider
- Loading branch information
1 parent
521df14
commit 50fce1f
Showing
7 changed files
with
119 additions
and
6 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,6 +43,8 @@ func TestSettingsValidate(t *testing.T) { | |
| s.MicrosoftAuth.ClientId = "" | ||
| s.SpotifyAuth.Enabled = true | ||
| s.SpotifyAuth.ClientId = "" | ||
| s.KakaoAuth.Enabled = true | ||
| s.KakaoAuth.ClientId = "" | ||
|
|
||
| // check if Validate() is triggering the members validate methods. | ||
| err := s.Validate() | ||
|
|
@@ -69,6 +71,7 @@ func TestSettingsValidate(t *testing.T) { | |
| `"twitterAuth":{`, | ||
| `"microsoftAuth":{`, | ||
| `"spotifyAuth":{`, | ||
| `"kakaoAuth":{`, | ||
| } | ||
|
|
||
| errBytes, _ := json.Marshal(err) | ||
|
|
@@ -113,6 +116,8 @@ func TestSettingsMerge(t *testing.T) { | |
| s2.MicrosoftAuth.ClientId = "microsoft_test" | ||
| s2.SpotifyAuth.Enabled = true | ||
| s2.SpotifyAuth.ClientId = "spotify_test" | ||
| s2.KakaoAuth.Enabled = true | ||
| s2.KakaoAuth.ClientId = "kakao_test" | ||
|
|
||
| if err := s1.Merge(s2); err != nil { | ||
| t.Fatal(err) | ||
|
|
@@ -182,6 +187,7 @@ func TestSettingsRedactClone(t *testing.T) { | |
| s1.TwitterAuth.ClientSecret = "test123" | ||
| s1.MicrosoftAuth.ClientSecret = "test123" | ||
| s1.SpotifyAuth.ClientSecret = "test123" | ||
| s1.KakaoAuth.ClientSecret = "test123" | ||
|
|
||
| s2, err := s1.RedactClone() | ||
| if err != nil { | ||
|
|
@@ -193,7 +199,7 @@ func TestSettingsRedactClone(t *testing.T) { | |
| t.Fatal(err) | ||
| } | ||
|
|
||
| expected := `{"meta":{"appName":"test123","appUrl":"http://localhost:8090","hideControls":false,"senderName":"Support","senderAddress":"[email protected]","verificationTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eThank you for joining us at {APP_NAME}.\u003c/p\u003e\n\u003cp\u003eClick on the button below to verify your email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eVerify\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Verify your {APP_NAME} email","actionUrl":"{APP_URL}/_/#/auth/confirm-verification/{TOKEN}"},"resetPasswordTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to reset your password.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eReset password\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to reset your password, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Reset your {APP_NAME} password","actionUrl":"{APP_URL}/_/#/auth/confirm-password-reset/{TOKEN}"},"confirmEmailChangeTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to confirm your new email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eConfirm new email\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to change your email address, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Confirm your {APP_NAME} new email address","actionUrl":"{APP_URL}/_/#/auth/confirm-email-change/{TOKEN}"}},"logs":{"maxDays":5},"smtp":{"enabled":false,"host":"smtp.example.com","port":587,"username":"","password":"******","tls":true},"s3":{"enabled":false,"bucket":"","region":"","endpoint":"","accessKey":"","secret":"******","forcePathStyle":false},"adminAuthToken":{"secret":"******","duration":1209600},"adminPasswordResetToken":{"secret":"******","duration":1800},"recordAuthToken":{"secret":"******","duration":1209600},"recordPasswordResetToken":{"secret":"******","duration":1800},"recordEmailChangeToken":{"secret":"******","duration":1800},"recordVerificationToken":{"secret":"******","duration":604800},"emailAuth":{"enabled":false,"exceptDomains":null,"onlyDomains":null,"minPasswordLength":0},"googleAuth":{"enabled":false,"clientSecret":"******"},"facebookAuth":{"enabled":false,"clientSecret":"******"},"githubAuth":{"enabled":false,"clientSecret":"******"},"gitlabAuth":{"enabled":false,"clientSecret":"******"},"discordAuth":{"enabled":false,"clientSecret":"******"},"twitterAuth":{"enabled":false,"clientSecret":"******"},"microsoftAuth":{"enabled":false,"clientSecret":"******"},"spotifyAuth":{"enabled":false,"clientSecret":"******"}}` | ||
| expected := `{"meta":{"appName":"test123","appUrl":"http://localhost:8090","hideControls":false,"senderName":"Support","senderAddress":"[email protected]","verificationTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eThank you for joining us at {APP_NAME}.\u003c/p\u003e\n\u003cp\u003eClick on the button below to verify your email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eVerify\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Verify your {APP_NAME} email","actionUrl":"{APP_URL}/_/#/auth/confirm-verification/{TOKEN}"},"resetPasswordTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to reset your password.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eReset password\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to reset your password, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Reset your {APP_NAME} password","actionUrl":"{APP_URL}/_/#/auth/confirm-password-reset/{TOKEN}"},"confirmEmailChangeTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to confirm your new email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eConfirm new email\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to change your email address, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Confirm your {APP_NAME} new email address","actionUrl":"{APP_URL}/_/#/auth/confirm-email-change/{TOKEN}"}},"logs":{"maxDays":5},"smtp":{"enabled":false,"host":"smtp.example.com","port":587,"username":"","password":"******","tls":true},"s3":{"enabled":false,"bucket":"","region":"","endpoint":"","accessKey":"","secret":"******","forcePathStyle":false},"adminAuthToken":{"secret":"******","duration":1209600},"adminPasswordResetToken":{"secret":"******","duration":1800},"recordAuthToken":{"secret":"******","duration":1209600},"recordPasswordResetToken":{"secret":"******","duration":1800},"recordEmailChangeToken":{"secret":"******","duration":1800},"recordVerificationToken":{"secret":"******","duration":604800},"emailAuth":{"enabled":false,"exceptDomains":null,"onlyDomains":null,"minPasswordLength":0},"googleAuth":{"enabled":false,"clientSecret":"******"},"facebookAuth":{"enabled":false,"clientSecret":"******"},"githubAuth":{"enabled":false,"clientSecret":"******"},"gitlabAuth":{"enabled":false,"clientSecret":"******"},"discordAuth":{"enabled":false,"clientSecret":"******"},"twitterAuth":{"enabled":false,"clientSecret":"******"},"microsoftAuth":{"enabled":false,"clientSecret":"******"},"spotifyAuth":{"enabled":false,"clientSecret":"******"},"kakaoAuth":{"enabled":false,"clientSecret":"******"}}` | ||
|
|
||
| if encodedStr := string(encoded); encodedStr != expected { | ||
| t.Fatalf("Expected\n%v\ngot\n%v", expected, encodedStr) | ||
|
|
@@ -212,18 +218,31 @@ func TestNamedAuthProviderConfigs(t *testing.T) { | |
| s.TwitterAuth.ClientId = "twitter_test" | ||
| s.MicrosoftAuth.ClientId = "microsoft_test" | ||
| s.SpotifyAuth.ClientId = "spotify_test" | ||
| s.KakaoAuth.ClientId = "kakao_test" | ||
|
|
||
| result := s.NamedAuthProviderConfigs() | ||
|
|
||
| encoded, err := json.Marshal(result) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| expected := `{"discord":{"enabled":false,"clientId":"discord_test"},"facebook":{"enabled":false,"clientId":"facebook_test"},"github":{"enabled":false,"clientId":"github_test"},"gitlab":{"enabled":true,"clientId":"gitlab_test"},"google":{"enabled":false,"clientId":"google_test"},"microsoft":{"enabled":false,"clientId":"microsoft_test"},"spotify":{"enabled":false,"clientId":"spotify_test"},"twitter":{"enabled":false,"clientId":"twitter_test"}}` | ||
|
|
||
| if encodedStr := string(encoded); encodedStr != expected { | ||
| t.Fatalf("Expected the same serialization, got \n%v", encodedStr) | ||
| encodedStr := string(encoded) | ||
|
|
||
| expectedParts := []string{ | ||
| `"discord":{"enabled":false,"clientId":"discord_test"}`, | ||
| `"facebook":{"enabled":false,"clientId":"facebook_test"}`, | ||
| `"github":{"enabled":false,"clientId":"github_test"}`, | ||
| `"gitlab":{"enabled":true,"clientId":"gitlab_test"}`, | ||
| `"google":{"enabled":false,"clientId":"google_test"}`, | ||
| `"microsoft":{"enabled":false,"clientId":"microsoft_test"}`, | ||
| `"spotify":{"enabled":false,"clientId":"spotify_test"}`, | ||
| `"twitter":{"enabled":false,"clientId":"twitter_test"}`, | ||
| `"kakao":{"enabled":false,"clientId":"kakao_test"}`, | ||
| } | ||
| for _, p := range expectedParts { | ||
| if !strings.Contains(encodedStr, p) { | ||
| t.Fatalf("Expected \n%s \nin \n%s", p, encodedStr) | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| package auth | ||
|
|
||
| import ( | ||
| "strconv" | ||
|
|
||
| "golang.org/x/oauth2" | ||
| "golang.org/x/oauth2/kakao" | ||
| ) | ||
|
|
||
| var _ Provider = (*Kakao)(nil) | ||
|
|
||
| // NameKakao is the unique name of the Kakao provider. | ||
| const NameKakao string = "kakao" | ||
|
|
||
| // Kakao allows authentication via Kakao OAuth2. | ||
| type Kakao struct { | ||
| *baseProvider | ||
| } | ||
|
|
||
| // NewKakaoProvider creates a new Kakao provider instance with some defaults. | ||
| func NewKakaoProvider() *Kakao { | ||
| return &Kakao{&baseProvider{ | ||
| scopes: []string{"account_email", "profile_nickname", "profile_image"}, | ||
| authUrl: kakao.Endpoint.AuthURL, | ||
| tokenUrl: kakao.Endpoint.TokenURL, | ||
| userApiUrl: "https://kapi.kakao.com/v2/user/me", | ||
| }} | ||
| } | ||
|
|
||
| // FetchAuthUser returns an AuthUser instance based on the Kakao's user api. | ||
| func (p *Kakao) FetchAuthUser(token *oauth2.Token) (*AuthUser, error) { | ||
| // https://developers.kakao.com/docs/latest/en/kakaologin/rest-api#req-user-info-response | ||
| rawData := struct { | ||
| Id int `json:"id"` | ||
| Profile struct { | ||
| Nickname string `json:"nickname"` | ||
| ImageUrl string `json:"profile_image"` | ||
| } `json:"properties"` | ||
| KakaoAccount struct { | ||
| Email string `json:"email"` | ||
| IsEmailVerified bool `json:"is_email_verified"` | ||
| IsEmailValid bool `json:"is_email_valid"` | ||
| } `json:"kakao_account"` | ||
| }{} | ||
|
|
||
| if err := p.FetchRawUserData(token, &rawData); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| user := &AuthUser{ | ||
| Id: strconv.Itoa(rawData.Id), | ||
| Username: rawData.Profile.Nickname, | ||
| AvatarUrl: rawData.Profile.ImageUrl, | ||
| } | ||
| if rawData.KakaoAccount.IsEmailValid && rawData.KakaoAccount.IsEmailVerified { | ||
| user.Email = rawData.KakaoAccount.Email | ||
| } | ||
|
|
||
| return user, nil | ||
| } |
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