Blomstra Sign In With Apple

IanM

Log in With Apple

A Flarum extension. Log in with Apple

Installation

Install with composer:

composer require blomstra/oauth-apple

Updating

composer update blomstra/oauth-apple
php flarum cache:clear

Configuration

Create an App ID for your website (https://developer.apple.com/account/resources/identifiers/list/bundleId) with the following details:
- Platform: iOS, tvOS, watchOS (I'm unsure if either choice has an effect for web apps)
- Description: (something like "example.com app id")
- Bundle ID (Explicit): com.example.id (or something similar)
- Check "Sign In With Apple"
Create a Service ID for your website (https://developer.apple.com/account/resources/identifiers/list/serviceId) with the following details:
- Description: (something like "example.com service id")
- Identifier: com.example.service (or something similar)
- Check "Sign In With Apple"
- Configure "Sign In With Apple":
  - Primary App Id: (select the primary app id created in step 1)
  - Web Domain: example.com (the domain of your web site)
  - Return URLs: https://example.com/auth/apple (the route pointing to the callback method in your controller)
  - Click "Save".
  - Click the "Edit" button to edit the details of the "Sign In With Apple"
    configuration we just created.
  - If you haven't verified the domain yet, download the verification file,
    upload it to https://example.com/.well-known/apple-developer-domain-association.txt, and then click the "Verify"
    button.
Create a Private Key for your website (https://developer.apple.com/account/resources/authkeys/list) with the following details:
- Key Name:
- Check "Sign In With Apple"
- Configure "Sign In With Apple":
  - Primary App ID: (select the primary app id created in step 1)
  - Click "Save"
- Click "Continue"
- Click "Register"
- Click "Download"
- Keep the file safe for use in step 4.
Fill in the following fields in the extension settings:
- team_id: This can be found on the top-right corner when logged into
  your Apple Developer account, right under your name.
- client_id: This is the identifier from the Service Id created in step
  2 above, for example com.example.service
- key_id: This is the identifier of the private key created in step 3
  above.
- Upload the key file downloaded in step 3.

The initial version of this extension was kindly sponsored by Kagi Search - an ad-free search engine

Links

IanM

Blomstra published this extension a few months ago, but we failed to create the extension discussion here on discuss, my aplogies..

ash3T

FYI. In case people want to use the "Sign In With Apple".

I just found out that it cost CAD$119 for each year if you want to get the Apple Developer program(which is a must to have a App Id). Please correct me if I am wrong.

And below is the screenshot for fees.

Umutcan

Do we need an Apple Developer account to have the "Sign in with Apple" system?

Can all users get OAuth access for free like Github, Discord?

IanM

Umutcan An Apple Dev account is required to create the keys, etc in order to setup the extension, but for users signing in with their Apple ID, they need nothing else

Umutcan

IanM I don't know if you have any information on the subject, but I want to ask with faith. I remember that we had to give money to open an Apple Developer account. Is this true?

IanM

Umutcan Developer account had to be paid for. Is this true?

Yes, I believe the current cost is $99 USD/year

Umutcan

IanM Thank you very much for your interest and response. Thanks for the extension.

Darkle

I have been given access to an Apple developer account for a couple of things, so I decided to take advantage and try this to see how it works, I ran into a problem that I wanted to confirm, in Return URLs should be used https://example.com/apple-signin?

I've been trying but I have not been able to do so, I have seen in the extension settings that appeared this other url https://example.com/auth/apple, with this apparently it works, so it's a typo of the OP?

Another thing is about the verification of the domain, to download the txt, I can't find the option anywhere, maybe they moved it? 🤔

IanM

Darkle yep, I can confirm it's a typo in the OP - I'll edit that in a moment 🙈

To confirm, the return URL expected by this extension, and therefore required to be entered on the Apple side is https://your-domain.com/auth/apple

Darkle Another thing is about the verification of the domain, to download the txt, I can't find the option anywhere, maybe they moved it?

Possibly.. It's been a few months since I last did this, but I do remember that I followed the steps above to get the .txt at the time..

Darkle

IanM Great! With the change to https://your-domain.com/auth/apple everything works fine (login/registration ok), it seems that maybe they have removed the domain verification directly? If not, I don't think it should be working for me...

IanM

Darkle it's entirely possible. "If it works, don't fix it" 😛

Just to be sure, I'll go thru the steps on one of my other forums in a day or so from scratch and note if there are any changes to the setup..

AntDock

There seems to be a problem. When I try to connect my Apple ID to my admin account on the platform, it works well on the Apple side and I can successfully log in with my Apple ID. However, as it went back to my site, it prompts me to sign up again, even though I am already logged in. The connection is unsuccessful. I’m sure that I set up the Apple Developer configurations correctly. Please do reach out to help.

alicerunsonfedora

AntDock There seems to be a problem. When I try to connect my Apple ID to my admin account on the platform, it works well on the Apple side and I can successfully log in with my Apple ID. However, as it went back to my site, it prompts me to sign up again, even though I am already logged in. The connection is unsuccessful. I’m sure that I set up the Apple Developer configurations correctly. Please do reach out to help.

I'd love to know how to get this resolved as well. I thought it was a problem with requests getting redirected to HTTP instead of HTTPS, but the problem still persists. Likewise, I'm just disabling the plugin for now until I can figure this part out.

Umutcan

Hello,
This extension has a mismatch on the Frontpage. The text of the other login extensions (fof/oauth) and the login text of the apple extension are not the same.

For example:

You can see in the picture that the text sizes are different.

This is a style error and can be fixed very easily.

luceos

Umutcan This is a style error and can be fixed very easily.

Thanks. Your contributions are very welcome and much appreciated.

IanM

Umutcan luceos Darkle

This is to comply with the Apple guidelines, hence the hardcoded values.

You are of course free to override and apply custom CSS, but as the extension maintainers, we cannot deviate from the Apple guidelines on this. Thank you for your understanding

Umutcan

luceos Will there be a style edit update? Any donations expected? Not enough workforce? Please don't get me wrong, I'm just curious.

Darkle

Umutcan Do you have a url to the page of the image you showed?

luceos

Umutcan you said it was simple, so i was assuming you would provide the fix..

Umutcan

Darkle Yes there is. You can access it by clicking this link. After visiting the link, please like this message so that I unlink it.

luceos I wrote such a message because I thought it should be compatible with other login extensions. But of course, you have the final word. 🤓

Darkle

Umutcan It just has some hardcoded values, instead of using the ones inherited from oauth, simply adding this would fix the font size issue:

.LogInButtons:not(.FoFLogInButtons--icons) .LogInButton--apple, .LinkedAccounts .LogInButton--apple {
    font-size: inherit!important;
}

Maybe I'll try to send a PR, but before that I think it would be more interesting to send one for oauth and fix the off-centre icons/text.