omniauth-apple 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -3
- data/README.md +71 -0
- data/lib/omniauth/apple/version.rb +1 -1
- data/lib/omniauth/strategies/apple.rb +2 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 221e35d0cf4add7e7015c2571ab6c36cd43119aa8ac1ebf6ad749e6d075ff342
|
|
4
|
+
data.tar.gz: ab591ea9afc76e0365a88d7838de284fd4eef30d9891f2cba73df4d718250738
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 52c7db989eae8f46ab8f76458d8b02b3df22de0f35116166d39ce970118a37901db7213f5d121f913f20b785c3c3b3c985b64cfacdd5cb5ced646ade4ad9182b
|
|
7
|
+
data.tar.gz: 96ca930d07a243a3ba6580702ddcace78d48d6b446ed1115c721535665c5607745c3dad76f9bed3cffb8cc897af0479485858fa4b48c7817e6e738c68762fe5c
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
## [Unreleased]
|
|
2
2
|
|
|
3
|
+
## [1.1.0] - 2022-09-27
|
|
4
|
+
|
|
5
|
+
### Fixed
|
|
6
|
+
|
|
7
|
+
- [#91](https://github.com/nhosoya/omniauth-apple/pull/91) explicitly specify auth_scheme for oauth2 v2+ support
|
|
8
|
+
|
|
3
9
|
## [1.1.0] - 2022-09-26
|
|
4
10
|
|
|
5
11
|
### Added
|
|
@@ -56,7 +62,9 @@
|
|
|
56
62
|
|
|
57
63
|
## [0.0.1] - 2019-06-07
|
|
58
64
|
|
|
59
|
-
[Unreleased]: https://github.com/nhosoya/omniauth-apple/compare/v1.0
|
|
60
|
-
[1.
|
|
61
|
-
[1.0
|
|
65
|
+
[Unreleased]: https://github.com/nhosoya/omniauth-apple/compare/v1.2.0...master
|
|
66
|
+
[1.2.0]: https://github.com/nhosoya/omniauth-apple/compare/v1.1.0...v1.2.0
|
|
67
|
+
[1.1.0]: https://github.com/nhosoya/omniauth-apple/compare/v1.0.2...v1.1.0
|
|
62
68
|
[1.0.2]: https://github.com/nhosoya/omniauth-apple/compare/v1.0.1...v1.0.2
|
|
69
|
+
[1.0.1]: https://github.com/nhosoya/omniauth-apple/compare/v1.0.0...v1.0.1
|
|
70
|
+
[1.0.0]: https://github.com/nhosoya/omniauth-apple/compare/v0.0.3...v1.0.0
|
data/README.md
CHANGED
|
@@ -34,6 +34,77 @@ Rails.application.config.middleware.use OmniAuth::Builder do
|
|
|
34
34
|
end
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
+
## Configuring "Sign In with Apple"
|
|
38
|
+
|
|
39
|
+
_other Sign In with Apple guides:_
|
|
40
|
+
- ["How To" by janak amarasena (2019)](https://medium.com/identity-beyond-borders/how-to-configure-sign-in-with-apple-77c61e336003)
|
|
41
|
+
- [the docs, by Apple](https://developer.apple.com/sign-in-with-apple/)
|
|
42
|
+
|
|
43
|
+
### Look out for the values you need for your config
|
|
44
|
+
1. your domain and subdomains, something like: `myapp.com`, `www.myapp.com`
|
|
45
|
+
2. your redirect uri, something like: `https://myapp.com/users/auth/apple/callback` (check `rails routes` to be sure)
|
|
46
|
+
3. omniauth's "client id" will be Apple's "bundle id", something like: `com.myapp`
|
|
47
|
+
4. you will get the "team id" value from Apple when you create your _**App Id**_, something like: `H000000B`
|
|
48
|
+
5. Apple will give you a `.p8` file, which you'll use to GENERATE your `:pem` value
|
|
49
|
+
|
|
50
|
+
### Steps
|
|
51
|
+
|
|
52
|
+
1. Log into your [Apple Developer Account](https://idmsa.apple.com/IDMSWebAuth/signin?appIdKey=891bd3417a7776362562d2197f89480a8547b108fd934911bcbea0110d07f757&path=%2Faccount%2F&rv=1)
|
|
53
|
+
(if you don't have one, you can [create one here](https://appleid.apple.com/account?appId=632&returnUrl=https%3A%2F%2Fdeveloper.apple.com%2Faccount%2F))
|
|
54
|
+
|
|
55
|
+
2. Get an App Id with the "Sign In with Apple" capability
|
|
56
|
+
- go to your [Identifiers](https://developer.apple.com/account/resources/identifiers/list) list
|
|
57
|
+
- [start a new Identifier](https://developer.apple.com/account/resources/identifiers/add/bundleId) by clicking on the + sign in the Identifiers List
|
|
58
|
+
- select _**App IDs**_ and click _**continue**_
|
|
59
|
+
- select _**App**_ and _**continue**_
|
|
60
|
+
- enter a description and a bundle id
|
|
61
|
+
- check the **_"Sign In with Apple"_** capability
|
|
62
|
+
- save it
|
|
63
|
+
|
|
64
|
+
3. Get a Services Id (which we will use as our client id)
|
|
65
|
+
- go to your [Identifiers](https://developer.apple.com/account/resources/identifiers/list) list
|
|
66
|
+
- [start a new Identifier](https://developer.apple.com/account/resources/identifiers/add/bundleId) by clicking on the + sign in the Identifiers List
|
|
67
|
+
- select _**Services IDs**_ and click _**continue**_
|
|
68
|
+
- enter a description and a bundle id
|
|
69
|
+
- make sure **_"Sign In with Apple"_** is checked, then click _**configure**_
|
|
70
|
+
- make sure the Primary App ID matches the App ID you configured earlier
|
|
71
|
+
- enter all the subdomains you might use (comma delimited):
|
|
72
|
+
|
|
73
|
+
example.com,www.example.com
|
|
74
|
+
|
|
75
|
+
- enter all the redirect URLS you might use (comma delimited):
|
|
76
|
+
|
|
77
|
+
https://example.com/users/auth/apple/callback,https://example.com/users/auth/apple/callback
|
|
78
|
+
|
|
79
|
+
- save the "Sign In with Apple" capability config and the Service Id
|
|
80
|
+
|
|
81
|
+
4. Get a Secret Key
|
|
82
|
+
- go to your [Keys](https://developer.apple.com/account/resources/authkeys/list) list
|
|
83
|
+
- [start a new Key](https://developer.apple.com/account/resources/authkeys/add) by clicking on the + sign in the Keys List
|
|
84
|
+
- enter a name
|
|
85
|
+
- make sure **_"Sign In with Apple"_** is checked, then click _**configure**_
|
|
86
|
+
- make sure the Primary App ID matches the App ID you configured earlier
|
|
87
|
+
- save the "Sign In with Apple" capability
|
|
88
|
+
- click "continue" to finish the Key config (you will be prompted to _**Download Your Key**_)
|
|
89
|
+
- Apple will give you a `.p8` file, keep it safe and secure (don't commit it).
|
|
90
|
+
|
|
91
|
+
### Mapping Apple Values to OmniAuth Values
|
|
92
|
+
- your `:team_id` is in the top-right of your App Id config (aka _**App ID Prefix**_), it looks like: `H000000B`
|
|
93
|
+
- your `:client_id` is in the top-right of your Services Id config (aka _**Identifier**_), it looks like: `com.example`
|
|
94
|
+
- your `:key_id` is on the left side of your Key Details page, it looks like: `XYZ000000`
|
|
95
|
+
- your `:pem` is the content of the `.p8` file you got from Apple, _**with an extra newline at the end**_
|
|
96
|
+
|
|
97
|
+
- example from a Devise config:
|
|
98
|
+
|
|
99
|
+
```ruby
|
|
100
|
+
config.omniauth :apple, ENV['APPLE_SERVICE_BUNDLE_ID'], '', {
|
|
101
|
+
scope: 'email name',
|
|
102
|
+
team_id: ENV['APPLE_APP_ID_PREFIX'],
|
|
103
|
+
key_id: ENV['APPLE_KEY_ID'],
|
|
104
|
+
pem: ENV['APPLE_P8_FILE_CONTENT_WITH_EXTRA_NEWLINE']
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
37
108
|
## Contributing
|
|
38
109
|
|
|
39
110
|
Bug reports and pull requests are welcome on GitHub at https://github.com/nhosoya/omniauth-apple.
|
|
@@ -11,7 +11,8 @@ module OmniAuth
|
|
|
11
11
|
option :client_options,
|
|
12
12
|
site: 'https://appleid.apple.com',
|
|
13
13
|
authorize_url: '/auth/authorize',
|
|
14
|
-
token_url: '/auth/token'
|
|
14
|
+
token_url: '/auth/token',
|
|
15
|
+
auth_scheme: :request_body
|
|
15
16
|
option :authorize_params,
|
|
16
17
|
response_mode: 'form_post',
|
|
17
18
|
scope: 'email name'
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: omniauth-apple
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- nhosoya
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: exe
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2022-09-
|
|
12
|
+
date: 2022-09-27 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: omniauth-oauth2
|