OAuth2 support

build_date.as

@@ -1 +1 @@
-public var build_date:String='2020_12_29';
+public var build_date:String='2024_06_05';

com/adobe/protocols/oauth2/OAuth2Const.as

@@ -0,0 +1,17 @@
+package com.adobe.protocols.oauth2
+{
+	public class OAuth2Const
+	{
+		public static const GRANT_TYPE_AUTHORIZATION_CODE:String = "authorization_code";
+		public static const GRANT_TYPE_RESOURCE_OWNER_CREDENTIALS:String = "password";
+		public static const GRANT_TYPE_REFRESH_TOKEN:String = "refresh_token";
+
+		public static const RESPONSE_TYPE_AUTHORIZATION_CODE:String = "code";
+		public static const RESPONSE_TYPE_IMPLICIT:String = "token";
+
+		public static const RESPONSE_PROPERTY_AUTHORIZATION_CODE:String = "code";
+		public static const RESPONSE_PROPERTY_ACCESS_TOKEN:String = "access_token";
+
+		public static const GOOGLE_INSTALLED_APPLICATION_REDIRECT_URI:String = "urn:ietf:wg:oauth:2.0:oob";
+	}
+}

com/adobe/protocols/oauth2/event/GetAccessTokenEvent.as

@@ -0,0 +1,173 @@
+package com.adobe.protocols.oauth2.event
+{
+	import flash.events.Event;
+
+	/**
+	 * Event that is broadcast when results from a <code>getAccessToken</code>
+	 * request are received.
+	 * 
+	 * @author Charles Bihis (www.whoischarles.com)
+	 */
+	public class GetAccessTokenEvent extends Event implements IOAuth2Event
+	{
+		/**
+		 * Event type for this event which encapsulates the response from
+		 * a <code>getAccessToken</code> request.
+		 * 
+		 * @eventType getAccessToken
+		 */
+		public static const TYPE:String = "getAccessToken";
+
+		private var _errorCode:String;
+		private var _errorMessage:String;
+		private var _accessToken:String;
+		private var _tokenType:String;
+		private var _expiresIn:int;
+		private var _refreshToken:String;
+		private var _scope:String;
+		private var _state:String;
+		private var _response:Object;
+
+		/**
+		 * Constructor.
+		 * 
+		 * @param bubbles (Optional) Parameter indicating whether or not the event bubbles
+		 * @param cancelable (Optional Parameter indicating whether or not the event is cancelable
+		 */
+		public function GetAccessTokenEvent(bubbles:Boolean = false, cancelable:Boolean = false)
+		{
+			super(TYPE, bubbles, cancelable);
+		}  // GetAccessTokenEvent
+
+		/**
+		 * Convenience function that will take a <code>getAccessToken</code> response
+		 * and parse its values.
+		 * 
+		 * @param response An object representing the response from a <code>getAccessToken</code> request
+		 */
+		public function parseAccessTokenResponse(response:Object):void
+		{
+			// required
+			_accessToken = response.access_token;
+			_tokenType = response.token_type;
+
+			// optional
+			_expiresIn = int(response.expires_in);
+			_refreshToken = response.refresh_token;
+			_scope = response.scope;
+			_state = response.state;
+
+			// extra
+			_response = response;
+		}
+
+		/**
+		 * Override of the clone function.
+		 * 
+		 * @return A new <code>GetAccessTokenEvent</code> object.
+		 */
+		public override function clone():Event
+		{
+			return new GetAccessTokenEvent();
+		}  // clone
+
+		/**
+		 * Error code for error after a failed <code>getAccessToken</code> request.
+		 */
+		public function get errorCode():String
+		{
+			return _errorCode;
+		}  // errorCode
+
+		/**
+		 * @private
+		 */
+		public function set errorCode(errorCode:String):void
+		{
+			_errorCode = errorCode;
+		}  // errorCode
+
+		/**
+		 * Error message for error after a failed <code>getAccessToken</code> request.
+		 */
+		public function get errorMessage():String
+		{
+			return _errorMessage;
+		}  // errorMessage
+
+		/**
+		 * @private
+		 */
+		public function set errorMessage(errorMessage:String):void
+		{
+			_errorMessage = errorMessage;
+		}  // errorMessage
+
+		/**
+		 * The access token issues by the authorization server.
+		 */
+		public function get accessToken():String
+		{
+			return _accessToken;
+		}  // accessToken
+
+		/**
+		 * The type of the token issued as described in the OAuth 2.0
+		 * v2.15 specification, section 7.1, "Access Token Types".
+		 * 
+		 * @see http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-7.1
+		 */
+		public function get tokenType():String
+		{
+			return _tokenType;
+		}  // tokenType
+
+		/**
+		 * The duration in seconds of the access token lifetime.  For example,
+		 * the value "3600" denotes that the access token will expire one hour
+		 * from the time the response was generated.
+		 */
+		public function get expiresIn():int
+		{
+			return _expiresIn;
+		}  // expiresIn
+
+		/**
+		 * The refresh token which can be used ot obtain new access tokens using
+		 * the same authorization grant as described in the OAuth 2.0
+		 * v2.15 specification, section 6, "Refreshing an Access Token".
+		 * 
+		 * @see http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-6
+		 */
+		public function get refreshToken():String
+		{
+			return _refreshToken;
+		}  // refreshToken
+
+		/**
+		 * The scope of the access request expressed as a list of space-delimited,
+		 * case-sensitive strings.
+		 */
+		public function get scope():String
+		{
+			return _scope;
+		}  // scope
+
+		/**
+		 * An opaque value used by the client to maintain state between the request
+		 * and callback.
+		 */
+		public function get state():String
+		{
+			return _state;
+		}  // state
+
+		/**
+		 * Response object to contain all returned response data after a successfull access token request.
+		 */
+		public function get response():Object
+		{
+			return _response;
+		}  // response
+	}  // class declaration
+}  // package

com/adobe/protocols/oauth2/event/IOAuth2Event.as

@@ -0,0 +1,16 @@
+package com.adobe.protocols.oauth2.event
+{
+	/**
+	 * Interface describing generic OAuth 2.0 events.
+	 * 
+	 * @author Charles Bihis (www.whoischarles.com)
+	 */
+	public interface IOAuth2Event
+	{
+		function get errorCode():String;
+		function set errorCode(errorCode:String):void;
+
+		function get errorMessage():String;
+		function set errorMessage(errorMessage:String):void;
+	}  // interface declaration
+}  // package

com/adobe/protocols/oauth2/event/RefreshAccessTokenEvent.as

@@ -0,0 +1,173 @@
+package com.adobe.protocols.oauth2.event
+{
+	import flash.events.Event;
+
+	/**
+	 * Event that is broadcast when results from a <code>refreshAccessToken</code>
+	 * request are received.
+	 * 
+	 * @author Charles Bihis (www.whoischarles.com)
+	 */
+	public class RefreshAccessTokenEvent extends Event implements IOAuth2Event
+	{
+		/**
+		 * Event type for this event which encapsulates the response from
+		 * a <code>refreshAccessToken</code> request.
+		 * 
+		 * @eventType refreshAccessToken
+		 */
+		public static const TYPE:String = "refreshAccessToken";
+
+		private var _errorCode:String;
+		private var _errorMessage:String;
+		private var _accessToken:String;
+		private var _tokenType:String;
+		private var _expiresIn:int;
+		private var _refreshToken:String;
+		private var _scope:String;
+		private var _state:String;
+		private var _response:Object;
+
+		/**
+		 * Constructor.
+		 * 
+		 * @param bubbles (Optional) Parameter indicating whether or not the event bubbles
+		 * @param cancelable (Optional Parameter indicating whether or not the event is cancelable
+		 */
+		public function RefreshAccessTokenEvent(bubbles:Boolean = false, cancelable:Boolean = false)
+		{
+			super(TYPE, bubbles, cancelable);
+		}  // RefreshAccessTokenEvent
+
+		/**
+		 * Convenience function that will take a <code>refreshAccessToken</code> response
+		 * and parse its values.
+		 * 
+		 * @param response An object representing the response from a <code>refreshAccessToken</code> request
+		 */
+		public function parseAccessTokenResponse(response:Object):void
+		{
+			// required
+			_accessToken = response.access_token;
+			_tokenType = response.token_type;
+
+			// optional
+			_expiresIn = int(response.expires_in);
+			_refreshToken = response.refresh_token;
+			_scope = response.scope;
+			_state = response.state;
+
+			// extra
+			_response = response;
+		}
+
+		/**
+		 * Override of the clone function.
+		 * 
+		 * @return A new <code>RefreshAccessTokenEvent</code> object.
+		 */
+		public override function clone():Event
+		{
+			return new GetAccessTokenEvent();
+		}  // clone
+
+		/**
+		 * Error code for error after a failed <code>refreshAccessToken</code> request.
+		 */
+		public function get errorCode():String
+		{
+			return _errorCode;
+		}  // errorCode
+
+		/**
+		 * @private
+		 */
+		public function set errorCode(errorCode:String):void
+		{
+			_errorCode = errorCode;
+		}  // errorCode
+
+		/**
+		 * Error message for error after a failed <code>refreshAccessToken</code> request.
+		 */
+		public function get errorMessage():String
+		{
+			return _errorMessage;
+		}  // errorMessage
+
+		/**
+		 * @private
+		 */
+		public function set errorMessage(errorMessage:String):void
+		{
+			_errorMessage = errorMessage;
+		}  // errorMessage
+
+		/**
+		 * The access token issues by the authorization server.
+		 */
+		public function get accessToken():String
+		{
+			return _accessToken;
+		}  // accessToken
+
+		/**
+		 * The type of the token issued as described in the OAuth 2.0
+		 * v2.15 specification, section 7.1, "Access Token Types".
+		 * 
+		 * @see http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-7.1
+		 */
+		public function get tokenType():String
+		{
+			return _tokenType;
+		}  // tokenType
+
+		/**
+		 * The duration in seconds of the access token lifetime.  For example,
+		 * the value "3600" denotes that the access token will expire one hour
+		 * from the time the response was generated.
+		 */
+		public function get expiresIn():int
+		{
+			return _expiresIn;
+		}  // expiresIn
+
+		/**
+		 * The refresh token which can be used ot obtain new access tokens using
+		 * the same authorization grant as described in the OAuth 2.0
+		 * v2.15 specification, section 6, "Refreshing an Access Token".
+		 * 
+		 * @see http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-6
+		 */
+		public function get refreshToken():String
+		{
+			return _refreshToken;
+		}  // refreshToken
+
+		/**
+		 * The scope of the access request expressed as a list of space-delimited,
+		 * case-sensitive strings.
+		 */
+		public function get scope():String
+		{
+			return _scope;
+		}  // scope
+
+		/**
+		 * An opaque value used by the client to maintain state between the request
+		 * and callback.
+		 */
+		public function get state():String
+		{
+			return _state;
+		}  // state
+
+		/**
+		 * Response object to contain all returned response data after a successfull access token request.
+		 */
+		public function get response():Object
+		{
+			return _response;
+		}  // response
+	}  // class declaration
+}  // package