123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222 |
- //
- // UniWebViewAuthenticationFlowDiscord.cs
- // Created by Wang Wei (@onevcat) on 2022-06-25.
- //
- // This file is a part of UniWebView Project (https://uniwebview.com)
- // By purchasing the asset, you are allowed to use this code in as many as projects
- // you want, only if you publish the final products under the name of the same account
- // used for the purchase.
- //
- // This asset and all corresponding files (such as source code) are provided on an
- // “as is” basis, without warranty of any kind, express of implied, including but not
- // limited to the warranties of merchantability, fitness for a particular purpose, and
- // noninfringement. In no event shall the authors or copyright holders be liable for any
- // claim, damages or other liability, whether in action of contract, tort or otherwise,
- // arising from, out of or in connection with the software or the use of other dealing in the software.
- //
-
- using System;
- using System.Collections.Generic;
- using UnityEngine;
- using UnityEngine.Events;
-
- /// <summary>
- /// A predefined authentication flow for Discord.
- ///
- /// This implementation follows the flow described here:
- /// https://discord.com/developers/docs/topics/oauth2
- ///
- /// See https://docs.uniwebview.com/guide/oauth2.html for a more detailed guide of authentication in UniWebView.
- /// </summary>
- public class UniWebViewAuthenticationFlowDiscord : UniWebViewAuthenticationCommonFlow, IUniWebViewAuthenticationFlow<UniWebViewAuthenticationDiscordToken> {
- /// <summary>
- /// The client ID of your Discord application.
- /// </summary>
- public string clientId = "";
-
- /// <summary>
- /// The client secret of your Discord application.
- /// </summary>
- public string clientSecret = "";
-
- /// <summary>
- /// The redirect URI of this Discord application.
- /// </summary>
- public string redirectUri = "";
-
- /// <summary>
- /// The scope string of all your required scopes.
- /// </summary>
- public string scope = "";
-
- /// <summary>
- /// Optional to control this flow's behaviour.
- /// </summary>
- public UniWebViewAuthenticationFlowDiscordOptional optional;
-
- private string responseType = "code";
- private string grantType = "authorization_code";
-
- private readonly UniWebViewAuthenticationConfiguration config =
- new UniWebViewAuthenticationConfiguration(
- "https://discord.com/api/oauth2/authorize",
- "https://discord.com/api/oauth2/token"
- );
-
- /// <summary>
- /// Starts the authentication flow with the standard OAuth 2.0.
- /// This implements the abstract method in `UniWebViewAuthenticationCommonFlow`.
- /// </summary>
- public override void StartAuthenticationFlow() {
- var flow = new UniWebViewAuthenticationFlow<UniWebViewAuthenticationDiscordToken>(this);
- flow.StartAuth();
- }
-
- /// <summary>
- /// Starts the refresh flow with the standard OAuth 2.0.
- /// This implements the abstract method in `UniWebViewAuthenticationCommonFlow`.
- /// </summary>
- /// <param name="refreshToken">The refresh token received with a previous access token response.</param>
- public override void StartRefreshTokenFlow(string refreshToken) {
- var flow = new UniWebViewAuthenticationFlow<UniWebViewAuthenticationDiscordToken>(this);
- flow.RefreshToken(refreshToken);
- }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- public UniWebViewAuthenticationConfiguration GetAuthenticationConfiguration() {
- return config;
- }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- public string GetCallbackUrl() {
- return redirectUri;
- }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- public Dictionary<string, string> GetAuthenticationUriArguments() {
- var authorizeArgs = new Dictionary<string, string> {
- { "client_id", clientId },
- { "redirect_uri", redirectUri },
- { "scope", scope },
- { "response_type", responseType }
- };
- if (optional != null) {
- if (optional.enableState) {
- var state = GenerateAndStoreState();
- authorizeArgs.Add("state", state);
- }
-
- if (optional.PKCESupport != UniWebViewAuthenticationPKCE.None) {
- var codeChallenge = GenerateCodeChallengeAndStoreCodeVerify(optional.PKCESupport);
- authorizeArgs.Add("code_challenge", codeChallenge);
-
- var method = UniWebViewAuthenticationUtils.ConvertPKCEToString(optional.PKCESupport);
- authorizeArgs.Add("code_challenge_method", method);
- }
- }
-
- return authorizeArgs;
- }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- public Dictionary<string, string> GetAccessTokenRequestParameters(string authResponse) {
- if (!authResponse.StartsWith(redirectUri)) {
- throw AuthenticationResponseException.UnexpectedAuthCallbackUrl;
- }
-
- var uri = new Uri(authResponse);
- var response = UniWebViewAuthenticationUtils.ParseFormUrlEncodedString(uri.Query);
- if (!response.TryGetValue("code", out var code)) {
- throw AuthenticationResponseException.InvalidResponse(authResponse);
- }
- if (optional.enableState) {
- VerifyState(response);
- }
- var parameters = new Dictionary<string, string> {
- { "client_id", clientId },
- { "client_secret", clientSecret },
- { "code", code },
- { "redirect_uri", redirectUri },
- { "grant_type", grantType },
- };
- if (CodeVerify != null) {
- parameters.Add("code_verifier", CodeVerify);
- }
-
- return parameters;
- }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- public Dictionary<string, string> GetRefreshTokenRequestParameters(string refreshToken) {
- return new Dictionary<string, string> {
- { "client_id", clientId },
- { "client_secret", clientSecret },
- { "refresh_token", refreshToken },
- { "grant_type", "refresh_token" }
- };
- }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- public UniWebViewAuthenticationDiscordToken GenerateTokenFromExchangeResponse(string exchangeResponse) {
- return UniWebViewAuthenticationTokenFactory<UniWebViewAuthenticationDiscordToken>.Parse(exchangeResponse);
- }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- [field: SerializeField]
- public UnityEvent<UniWebViewAuthenticationDiscordToken> OnAuthenticationFinished { get; set; }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- [field: SerializeField]
- public UnityEvent<long, string> OnAuthenticationErrored { get; set; }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- [field: SerializeField]
- public UnityEvent<UniWebViewAuthenticationDiscordToken> OnRefreshTokenFinished { get; set; }
-
- /// <summary>
- /// Implements required method in `IUniWebViewAuthenticationFlow`.
- /// </summary>
- [field: SerializeField]
- public UnityEvent<long, string> OnRefreshTokenErrored { get; set; }
- }
-
- /// <summary>
- /// The authentication flow's optional settings for Discord.
- /// </summary>
- [Serializable]
- public class UniWebViewAuthenticationFlowDiscordOptional {
- /// <summary>
- /// Whether to enable PKCE when performing authentication. On mobile platforms, this has to be enabled as `S256`,
- /// otherwise, Discord will reject the authentication request.
- /// </summary>
- public UniWebViewAuthenticationPKCE PKCESupport = UniWebViewAuthenticationPKCE.S256;
- /// <summary>
- /// Whether to enable the state verification. If enabled, the state will be generated and verified in the
- /// authentication callback. Default is `true`.
- /// </summary>
- public bool enableState = true;
- }
-
- /// <summary>
- /// The token object from Discord. Check `UniWebViewAuthenticationStandardToken` for more.
- /// </summary>
- public class UniWebViewAuthenticationDiscordToken : UniWebViewAuthenticationStandardToken { }
|