[AuthenticationServices] Updates for Xcode13 Beta3 #12203

tj-devel709 · 2021-07-23T16:01:33Z

Closed #12043 in favor of this PR.
I tried to squash and rebase on top of main for this PR so hopefully I didn't miss any commits!

src/AuthenticationServices/PublicPrivateKeyAuthentication.cs

spouliot · 2021-07-23T17:19:10Z

src/authenticationservices.cs

+
+		[Mac (12,0), iOS (15,0), MacCatalyst (15,0)]
+		[Export ("privateKeys")]
+		NSObject[] PrivateKeys { get; }


+/*! @abstract Private SecKeys returned from the AuthenticationServices extension. + */ +@property (nonatomic, readonly) NSArray *privateKeys API_AVAILABLE(ios(15.0), macos(12.0)) API_UNAVAILABLE(tvos, watchos);

SecKey is a type - so it should be an array of them

Hmm, so I see that SecKey is created in this manual class here src/Security/Certificate.cs.
The namespace is Security, but when I add 'using Security' the compiler still says that it cannot find the reference.

That might require some changes in the generator. It does not seems to allow SecKey at the moment.

Still it's important because SecKey is not a subclass of NSObject, so the binding are incorrect without that fix.

Should I create an issue and link that in the binding?

yes, comment the bindings and create an issue
also add it to the checklist for xcode13

Clarification: leave a comment saying this should be SecKey or comment out this whole property and leave a note there about it?

Comment the property binding

Add a link to the issue you created inside the comment

Add a link to the issue to Xcode 13: list of changes to be reviewed/reverted before final release #11883

Why ?

It's not usable as an NSObject (since SecKey is not a subclass of it)

if we forget it (or lack time to update) then we're not creating a future breaking change

It's always easier to add (later) than to remove :)
IOW never add something "new" that's not right / needs to be fixed

Not an issue with the generator. SecKey was in a #if COREBUILD moving the #if to provide the minimum fixed the problem. I have pushed the fix.

src/authenticationservices.cs

spouliot · 2021-07-23T17:21:01Z

src/authenticationservices.cs

+	[DisableDefaultCtor]
+	interface ASAuthorizationPlatformPublicKeyCredentialAssertionRequest : ASAuthorizationPublicKeyCredentialAssertionRequest
+	{
+		[Sealed]


why ? iow worth a comment

So I actually don't remember told me to add the Sealed or if I saw a suggestion somewhere, perhaps @dalexsoto told me?
But when I remove it, I get these build errors: https://gist.github.com/tj-devel709/d459d9e717a186486deab6479f57c050

That error is because you're using the same selector for multiple methods/properties.

Why is that called PlatformAllowedCredentials if the selector is allowedCredentials ?

Oh I just remembered what is going on! Alex did help me with this one a few weeks ago!

So there are two different classes that use this similar "allowedCredentials" header: ASAuthorizationPlatformPublicKeyCredentialAssertionRequest and ASAuthorizationSecurityKeyPublicKeyCredentialAssertionRequest

The return type of the former is ASAuthorizationPlatformPublicKeyCredentialDescriptor[]
and the return type of the second one is ASAuthorizationSecurityKeyPublicKeyCredentialDescriptor[]

but they both are overriding a property from the protocol ASAuthorizationPublicKeyCredentialAssertionRequest
which has the base property "allowedCredentials" that is of type IASAuthorizationPublicKeyCredentialDescriptor[]

So to get past this typing confusion, Alex suggested giving them different names and sealing the properties in the child classes. I definitely should have made a comment because I had already forgotten about this.

That used to be a problem but C# now have covariant returns
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/proposals/csharp-9.0/covariant-returns

I wonder if just using [Override] would work...
or if more change are needed

The main problem with this rename-approach is that it's not easily discoverable by developers - so they might still use the original (base) one and have to deal with casts

Using just the Override attribute gives me the following errors

I was wondering if maybe the protocol interface method needs a virtual attribute?

[The Sealed Attribute] Instructs the generator to flag the generated method as sealed. If this attribute is not specified, the default is to generate a virtual method (either a virtual method, an abstract method or an override depending on how other attributes are used).

This method is marked abstract and is maybe not virtual by default because of that?

it's not a big deal, let's land this as-is (unless someone else objects) and I might have a have a quick look

spouliot · 2021-07-23T17:21:13Z

src/authenticationservices.cs

+	[DisableDefaultCtor]
+	interface ASAuthorizationSecurityKeyPublicKeyCredentialAssertionRequest : ASAuthorizationPublicKeyCredentialAssertionRequest
+	{
+		[Sealed]


src/authenticationservices.cs

spouliot · 2021-07-23T17:23:29Z

src/authenticationservices.cs

+		NSData HttpBody { get; set; }
+
+		[Export ("privateKeys", ArgumentSemantic.Assign)]
+		NSObject[] PrivateKeys { get; set; }


likely SecKey[]

spouliot · 2021-07-23T17:24:09Z

src/authenticationservices.cs

+		IntPtr Constructor (nint algorithm);
+
+		[Export ("algorithm")]
+		nint Algorithm { get; }


+@property (nonatomic, readonly) ASCOSEAlgorithmIdentifier algorithm;

why not use the type ?

I cannot find this type in our bindings using grep

it might be new... not sure why xtro did not pick it up
you need to track the header files to see/learn why :)

Hmm okay so the headers didn't really reveal anything to me: @abstract A COSE algorithm indentifier.
but looking at the web docs and looking up what ASCOSEAlgorithmIdentifier reveals that it is a type alias and has this:
typedef NSInteger ASCOSEAlgorithmIdentifier;
But I am not sure if this is any better?
https://developer.apple.com/documentation/authenticationservices/ascosealgorithmidentifier?language=objc

I'll keep looking at this after the meeting though

It's not how most enums are defined - and it seems sharpie does not process them when defined this way.

API_AVAILABLE(macos(12.0), ios(15.0)) API_UNAVAILABLE(watchos) typedef NSInteger ASCOSEAlgorithmIdentifier NS_TYPED_EXTENSIBLE_ENUM; /*! @abstract The COSE algorithm identifier representing ECDSA with SHA-256. */ API_AVAILABLE(macos(12.0), ios(15.0)) API_UNAVAILABLE(watchos) static ASCOSEAlgorithmIdentifier const ASCOSEAlgorithmIdentifierES256 = -7;

/Applications/Xcode_13.0.0-beta3.app//Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/AuthenticationServices.framework/Headers/ASCOSEConstants.h

Also check for ASCOSEEllipticCurveIdentifier since it might suffer from the same nine issue

AH thanks for finding this! I will grep the header files next time!

Interestingly, ASCOSEEllipticCurveIdentifier is only declared but not used

some new (b4?) API might eventually use it
but no need to bind it until we have a need for it :)

spouliot · 2021-07-23T17:25:06Z

src/AuthenticationServices/PublicPrivateKeyAuthentication.cs

+
+        public static /* ASAuthorizationSecurityKeyPublicKeyCredentialDescriptorTransport[] */ NSString[] GetAllSupportedPublicKeyCredentialDescriptorTransports () {
+            return NSArray.ArrayFromHandle<NSString> (ASAuthorizationAllSupportedPublicKeyCredentialDescriptorTransports ());
+        }


you have ASAuthorizationSecurityKeyPublicKeyCredentialDescriptorTransport defined
there's no point in exposing the list (only) as NSString

Are you suggesting to do something like this?

public static ASAuthorizationSecurityKeyPublicKeyCredentialDescriptorTransport[] GetAllSupportedPublicKeyCredentialDescriptorTransports () { return NSArray.ArrayFromHandle<ASAuthorizationSecurityKeyPublicKeyCredentialDescriptorTransport> (ASAuthorizationAllSupportedPublicKeyCredentialDescriptorTransports ()); }

For the API signature ? yes
Not sure the implementation will compile...

it does not currently compile since ASAuthorizationSecurityKeyPublicKeyCredentialDescriptorTransport is an enum and it complains saying that it needs to be a reference type:

error CS0452: The type 'ASAuthorizationSecurityKeyPublicKeyCredentialDescriptorTransport' must be a reference type in order to use it as parameter 'T' in the generic type or method 'NSArray.ArrayFromHandle<T>(IntPtr)'

Should I try turning the enum into an interface so that it can be a reference type?

no, you just need a bit more code
You already get an array of NSString and you can create an array of the enum and convert each string constant into it's enum value

vs-mobiletools-engineering-service2 · 2021-07-23T21:57:26Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

1 tests failed, 88 tests passed.

Failed tests

monotouch-test/Mac Catalyst/Debug [dotnet]: Failed (Tests run: 2630 Passed: 2485 Inconclusive: 35 Failed: 3 Ignored: 142)

Pipeline on Agent XAMBOT-1101.BigSur'
Merge d398ac6 into de86250

vs-mobiletools-engineering-service2 · 2021-07-26T20:03:20Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

1 tests failed, 88 tests passed.

Failed tests

monotouch-test/Mac Catalyst/Debug [dotnet]: Failed (Tests run: 2630 Passed: 2485 Inconclusive: 35 Failed: 3 Ignored: 142)

Pipeline on Agent XAMBOT-1102.BigSur'
Merge 833b168 into c0651c9

src/authenticationservices.cs

spouliot · 2021-07-27T20:51:24Z

src/authenticationservices.cs

@@ -1002,6 +1003,18 @@ enum ASAuthorizationSecurityKeyPublicKeyCredentialDescriptorTransport {
 		Bluetooth,
 	}

+	[Mac (12,0), iOS (15,0), MacCatalyst (15,0), NoWatch, NoTV]
+	[Native]
+	enum ASCOSEAlgorithmIdentifier : long {


ASCoseAlgorithmIdentifier

spouliot · 2021-07-27T20:52:08Z

src/authenticationservices.cs

+	[Mac (12,0), iOS (15,0), MacCatalyst (15,0), NoWatch, NoTV]
+	[Native]
+	enum ASCOSEAlgorithmIdentifier : long {
+		Es256 = -7,


but ES256 since two-letters acronyms remains uppercase in .net
3+ letters acronyms become Pascal-cased

vs-mobiletools-engineering-service2 · 2021-07-28T00:27:12Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

2 tests failed, 87 tests passed.

Failed tests

monotouch-test/Mac Catalyst/Debug [dotnet]: Failed (Tests run: 2630 Passed: 2488 Inconclusive: 35 Failed: 1 Ignored: 141)
xcframework-test/Mac Catalyst/Debug: TimedOut (Execution timed out after 1200 seconds.
No test log file was produced)

Pipeline on Agent XAMBOT-1102.BigSur'
Merge c426195 into f611cd8

…onServices-beta3

vs-mobiletools-engineering-service2 · 2021-07-29T05:53:17Z

✅ [PR Build] Tests passed on Build. ✅

Tests passed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

🎉 All 89 tests passed 🎉

Pipeline on Agent XAMBOT-1104.BigSur'
Merge 67bd7d4 into 38140f2

vs-mobiletools-engineering-service2 · 2021-07-29T22:15:55Z

✅ [PR Build] Tests passed on Build. ✅

Tests passed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

🎉 All 89 tests passed 🎉

Pipeline on Agent XAMBOT-1100.BigSur'
Merge fb56728 into 448cc6e

vs-mobiletools-engineering-service2 · 2021-07-30T02:48:46Z

✅ [PR Build] Tests passed on Build. ✅

Tests passed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

🎉 All 89 tests passed 🎉

Pipeline on Agent XAMBOT-1105.BigSur'
Merge 182b8cb into 448cc6e

vs-mobiletools-engineering-service2 · 2021-08-03T22:50:49Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

ℹ️ API Diff (from PR only) (please review changes)
ℹ️ Generator Diff (please review changes)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

3 tests failed, 87 tests passed.

Failed tests

introspection/Mac Catalyst/Debug [dotnet]: TimedOut (Execution timed out after 1200 seconds.
No test log file was produced)
monotouch-test/Mac Catalyst/Debug [dotnet]: Failed (Tests run: 2630 Passed: 2490 Inconclusive: 35 Failed: 1 Ignored: 139)
dont link/Mac Catalyst/Debug: TimedOut (Execution timed out after 1200 seconds.
No test log file was produced)

Pipeline on Agent XAMBOT-1103.BigSur'
Merge 7508c47 into fda13f2

mandel-macaque · 2021-08-04T14:11:16Z

Unrelated issues:

Initial Changes

d398ac6

tj-devel709 added the note-highlight Worth calling out specifically in release notes label Jul 23, 2021

tj-devel709 added this to the xcode13.0 milestone Jul 23, 2021

tj-devel709 requested a review from spouliot as a code owner July 23, 2021 16:01

tj-devel709 mentioned this pull request Jul 23, 2021

[AuthenticationServices] Updates for Xcode13 Beta3 #12043

Closed

rolfbjarne approved these changes Jul 23, 2021

View reviewed changes

src/AuthenticationServices/PublicPrivateKeyAuthentication.cs Outdated Show resolved Hide resolved

spouliot suggested changes Jul 23, 2021

View reviewed changes

first part of Sebastien's suggestions

833b168

adding in enum

c426195

spouliot suggested changes Jul 27, 2021

View reviewed changes

tj_devel709 added 2 commits July 28, 2021 19:35

Merge remote-tracking branch 'xamarin/main' into Xcode13-Authenticati…

5c0b615

…onServices-beta3

fixed test case

67bd7d4

tj_devel709 added 3 commits July 29, 2021 10:07

proper capitalization

3f1d020

forgot one capitalization

9fb185e

linking in Issue

fb56728

Merge branch 'main' into Xcode13-AuthenticationServices-beta3

182b8cb

mandel-macaque approved these changes Aug 3, 2021

View reviewed changes

mandel-macaque added 2 commits August 3, 2021 13:27

Merge branch 'main' into Xcode13-AuthenticationServices-beta3

d6b1bda

Fix API to use SecKey in the bindings.

7508c47

tj-devel709 requested a review from dalexsoto as a code owner August 3, 2021 17:43

spouliot approved these changes Aug 3, 2021

View reviewed changes

mandel-macaque merged commit 68a5091 into xamarin:main Aug 4, 2021

[AuthenticationServices] Updates for Xcode13 Beta3 #12203

[AuthenticationServices] Updates for Xcode13 Beta3 #12203

Conversation

tj-devel709 commented Jul 23, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tj-devel709 Jul 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tj-devel709 Jul 27, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vs-mobiletools-engineering-service2 commented Jul 23, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

vs-mobiletools-engineering-service2 commented Jul 26, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vs-mobiletools-engineering-service2 commented Jul 28, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

vs-mobiletools-engineering-service2 commented Jul 29, 2021

✅ [PR Build] Tests passed on Build. ✅

API diff

API & Generator diff

GitHub pages

🎉 All 89 tests passed 🎉

vs-mobiletools-engineering-service2 commented Jul 29, 2021

✅ [PR Build] Tests passed on Build. ✅

API diff

API & Generator diff

GitHub pages

🎉 All 89 tests passed 🎉

vs-mobiletools-engineering-service2 commented Jul 30, 2021

✅ [PR Build] Tests passed on Build. ✅

API diff

API & Generator diff

GitHub pages

🎉 All 89 tests passed 🎉

vs-mobiletools-engineering-service2 commented Aug 3, 2021

❌ [PR Build] Tests failed on Build ❌

tj-devel709 Jul 26, 2021 •

edited

Loading

tj-devel709 Jul 27, 2021 •

edited

Loading