Skip to content

Commit d416f91

Browse files
committed
README improvements
1 parent 7d7a27d commit d416f91

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

README.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,37 @@ navigator.credentials.get = function (options) {
2323
import Passkey from 'electron-passkey';
2424

2525
ipcMain.handle('webauthn-create', (event, options) => {
26-
return Passkey.handlePasskeyCreate(options);
26+
return Passkey.getInstance().handlePasskeyCreate(options);
2727
});
2828

2929
ipcMain.handle('webauthn-get', (event, options) => {
30-
return Passkey.handlePasskeyGet(options);
30+
return Passkey.getInstance().handlePasskeyGet(options);
3131
});
3232
```
3333

34+
### Entitlements Setup
35+
36+
> **_NOTE:_** Ensure your AASA is passing validation **BEFORE** you check it against Apple's CDN **AND BEFORE** you run your application with the entitlements or Apple may temporarily cache an invalid AASA and you will be stuck until they recheck
37+
38+
1) In developer.apple.com create an app identifier
39+
2) Enable Associated Domains for your identifier
40+
![AssociatedDomains](images/AssociatedDomains.png "Associated Domains")
41+
3) You may need to create a provisioning profile for macOS development on your device and/or for distribution
42+
4) Create a webserver to serve an AASA file [as specificed in the docs](https://developer.apple.com/documentation/xcode/supporting-associated-domains#Add-the-associated-domain-file-to-your-website)
43+
5) Test it with the [yURL validator](https://branch.io/resources/aasa-validator/) and/or [branch.io validator](https://branch.io/resources/aasa-validator/)
44+
6) Add the following to your entitlements plist
45+
```plist
46+
<key>com.apple.application-identifier</key>
47+
<string>TEAMID.APP-ID</string>
48+
<key>com.apple.developer.associated-domains</key>
49+
<array>
50+
<string>applinks:DOMAIN</string>
51+
<string>webcredentials:DOMAIN</string>
52+
</array>
53+
```
54+
7) Check to see if your AASA is being cached by the Apple CDN at `https://app-site-association.cdn-apple.com/a/v1/DOMAIN`
55+
8) Build your electron application and sign it
56+
3457
### Deployments
3558

3659
![Deployments](Deployment.png "Deplyoments")

images/AssociatedDomains.png

17.9 KB
Loading

0 commit comments

Comments
 (0)