Implement extension method for authentication flow

2026-06-09 21:09:51 +00:00 · 2015-04-21 14:46:16 -07:00
parent 408e95c421
commit 2e1ade43f1
1 changed files with 138 additions and 2 deletions
@@ -33,8 +33,7 @@ namespace Octokit
            string clientId,
            string clientSecret,
            NewAuthorization newAuthorization,
-            Func<TwoFactorRequiredException, IObservable<TwoFactorChallengeResult>> twoFactorChallengeHandler
-            )
+            Func<TwoFactorRequiredException, IObservable<TwoFactorChallengeResult>> twoFactorChallengeHandler)
        {
            Ensure.ArgumentNotNull(authorizationsClient, "authorizationsClient");
            Ensure.ArgumentNotNullOrEmptyString(clientId, "clientId");
@@ -55,5 +54,142 @@ namespace Octokit
                                newAuthorization,
                                result.AuthenticationCode)));
        }
+
+        /// <summary>
+        /// This method will create a new authorization for the specified OAuth application. If an authorization 
+        /// for that application already exists for the user and fingerprint, it'll delete the existing one and 
+        /// recreate it.
+        /// </summary>
+        /// <remarks>
+        /// <para>
+        /// This method is typically used to initiate an application authentication flow.
+        /// This method allows the caller to provide a callback which is used to retrieve the two-factor code from
+        /// the user. Typically the callback is used to show some user interface to the user.
+        /// </para>
+        /// <para>
+        /// See <a href="http://developer.github.com/v3/oauth/#list-your-authorizations">API documentation</a> 
+        /// for more details.
+        /// </para>
+        /// </remarks>
+        /// <param name="authorizationsClient">The <see cref="IAuthorizationsClient" /> this method extends</param>
+        /// <param name="clientId">Client ID for the OAuth application that is requesting the token</param>
+        /// <param name="clientSecret">The client secret</param>
+        /// <param name="newAuthorization">Defines the scopes and metadata for the token</param>
+        /// <param name="twoFactorChallengeHandler">Callback used to retrieve the two-factor authentication code
+        /// from the user</param>
+        /// <param name="retryInvalidTwoFactorCode">If true, instead of completing when the two factor code supplied
+        /// is invalid, we go through the whole cycle again and prompt the two factor dialog.</param>
+        /// <returns></returns>
+        public static IObservable<ApplicationAuthorization> CreateAndDeleteExistingApplicationAuthentication(
+            this IObservableAuthorizationsClient authorizationsClient,
+            string clientId,
+            string clientSecret,
+            NewAuthorization newAuthorization,
+            Func<TwoFactorRequiredException, IObservable<TwoFactorChallengeResult>> twoFactorChallengeHandler,
+            bool retryInvalidTwoFactorCode)
+        {
+            return authorizationsClient.CreateAndDeleteExistingApplicationAuthentication(
+                clientId,
+                clientSecret,
+                newAuthorization,
+                twoFactorChallengeHandler,
+                null,
+                retryInvalidTwoFactorCode);
+        }
+
+        static IObservable<ApplicationAuthorization> CreateAndDeleteExistingApplicationAuthentication(
+            this IObservableAuthorizationsClient authorizationsClient,
+            string clientId,
+            string clientSecret,
+            NewAuthorization newAuthorization,
+            Func<TwoFactorRequiredException, IObservable<TwoFactorChallengeResult>> twoFactorChallengeHandler,
+            string twoFactorAuthenticationCode,
+            bool retryInvalidTwoFactorCode)
+        {
+            Ensure.ArgumentNotNull(authorizationsClient, "authorizationsClient");
+            Ensure.ArgumentNotNullOrEmptyString(clientId, "clientId");
+            Ensure.ArgumentNotNullOrEmptyString(clientSecret, "clientSecret");
+            Ensure.ArgumentNotNull(newAuthorization, "newAuthorization");
+
+            return authorizationsClient.GetOrCreateAuthorizationUnified(clientId, clientSecret, newAuthorization, twoFactorAuthenticationCode)
+                .Catch<ApplicationAuthorization, TwoFactorRequiredException>(exception => twoFactorChallengeHandler(exception)
+                    .SelectMany(result =>
+                        result.ResendCodeRequested
+                            ? authorizationsClient.CreateAndDeleteExistingApplicationAuthentication(
+                                clientId,
+                                clientSecret,
+                                newAuthorization,
+                                twoFactorChallengeHandler,
+                                null,
+                                retryInvalidTwoFactorCode)
+                            : retryInvalidTwoFactorCode
+                                // Attempt to create authorization and if it fails, show the 2fa dialog.
+                                ? authorizationsClient.CreateAndDeleteExistingApplicationAuthentication(
+                                    clientId,
+                                    clientSecret,
+                                    newAuthorization,
+                                    twoFactorChallengeHandler,
+                                    result.AuthenticationCode,
+                                    true)
+                                // Attempt to create authorization and if it fails, don't show the 2fa dialog.
+                                : authorizationsClient.CreateAuthorizationAndDeleteExisting(
+                                    clientId,
+                                    clientSecret,
+                                    newAuthorization,
+                                    result.AuthenticationCode)));
+        }
+
+        // If the Application Authorization already exists, the result might have an empty string as the token. This is
+        // because GitHub.com no longer stores the token, but stores a hashed version of it. It is assumed that clients
+        // will store the token locally.
+        // The only reason to be calling GetOrCreateApplicationAuthentication is pretty much the case when you are
+        // logging in and thus don't have the token already. So if the token returned is an empty string, we'll go
+        // ahead and delete it for you and then recreate it.
+        static IObservable<ApplicationAuthorization> CreateAuthorizationAndDeleteExisting(
+            this IObservableAuthorizationsClient authorizationsClient,
+            string clientId,
+            string clientSecret,
+            NewAuthorization newAuthorization,
+            string twoFactorAuthenticationCode = null)
+        {
+            return authorizationsClient.GetOrCreateAuthorizationUnified(
+                clientId,
+                clientSecret,
+                newAuthorization,
+                twoFactorAuthenticationCode)
+                .SelectMany(authorization => string.IsNullOrEmpty(authorization.Token)
+                    ? authorizationsClient.Delete(authorization.Id, twoFactorAuthenticationCode)
+                        .SelectMany(_ =>
+                            authorizationsClient.CreateNewAuthorization(
+                                clientId,
+                                clientSecret,
+                                newAuthorization,
+                                twoFactorAuthenticationCode))
+                    : Observable.Return(authorization));
+        }
+
+        static IObservable<ApplicationAuthorization> GetOrCreateAuthorizationUnified(
+            this IObservableAuthorizationsClient authorizationsClient,
+            string clientId,
+            string clientSecret,
+            NewAuthorization newAuthorization,
+            string twoFactorAuthenticationCode = null)
+        {
+            return string.IsNullOrEmpty(twoFactorAuthenticationCode)
+                ? authorizationsClient.GetOrCreateApplicationAuthentication(clientId, clientSecret, newAuthorization)
+                : authorizationsClient.GetOrCreateApplicationAuthentication(clientId, clientSecret, newAuthorization, twoFactorAuthenticationCode);
+        }
+
+        static IObservable<ApplicationAuthorization> CreateNewAuthorization(
+            this IObservableAuthorizationsClient authorizationsClient,
+            string clientId,
+            string clientSecret,
+            NewAuthorization newAuthorization,
+            string twoFactorAuthenticationCode = null)
+        {
+            return string.IsNullOrEmpty(twoFactorAuthenticationCode)
+                ? authorizationsClient.Create(clientId, clientSecret, newAuthorization)
+                : authorizationsClient.Create(clientId, clientSecret, newAuthorization, twoFactorAuthenticationCode);
+        }
    }
 }