Guía de integración de Amazon FireOS (heredada) amazon-fireos-integration-cookbook
Introducción intro
En este documento se describen los flujos de trabajo de derechos que la aplicación de nivel superior de un programador puede implementar a través de las API expuestas por la biblioteca AccessEnabler
de Amazon FireOS.
La solución de asignación de derechos de autenticación de Adobe Pass para Amazon FireOS se divide finalmente en dos dominios:
-
Dominio de interfaz de usuario: es la capa de aplicación de nivel superior que implementa la interfaz de usuario y utiliza los servicios proporcionados por la biblioteca
AccessEnabler
para proporcionar acceso al contenido restringido. -
Dominio
AccessEnabler
: aquí es donde se implementan los flujos de trabajo de derechos en forma de:- Llamadas de red realizadas a los servidores back-end de Adobe
- Reglas de lógica empresarial relacionadas con los flujos de trabajo de autenticación y autorización
- Administración de varios recursos y procesamiento del estado del flujo de trabajo (como la caché de símbolos)
El objetivo del dominio AccessEnabler
es ocultar todas las complejidades de los flujos de trabajo de asignación de derechos y proporcionar a la aplicación de nivel superior (a través de la biblioteca AccessEnabler
) un conjunto de primitivas de asignación de derechos simples. Este proceso permite implementar los flujos de trabajo de derechos:
- Establezca la identidad del solicitante.
- Comprobación y obtención de autenticación con un proveedor de identidad concreto.
- Compruebe y obtenga autorización para un recurso en particular.
- Cerrar sesión.
La actividad de red de AccessEnabler
tiene lugar en un subproceso diferente, por lo que el subproceso de interfaz de usuario nunca se bloquea. Como resultado, el canal de comunicación bidireccional entre los dos dominios de aplicación debe seguir un patrón totalmente asincrónico:
- La capa de aplicación de la interfaz de usuario envía mensajes al dominio
AccessEnabler
mediante las llamadas de API expuestas por la bibliotecaAccessEnabler
. AccessEnabler
responde a la capa de interfaz de usuario mediante los métodos de devolución de llamada incluidos en el protocoloAccessEnabler
que la capa de interfaz de usuario registra con la bibliotecaAccessEnabler
.
Flujos de derecho entitlement
A. Requisitos previos prereqs
-
Cree sus funciones de devolución de llamada:
-
- Activado por
setRequestor()
, devuelve éxito o error. El éxito indica que se puede continuar con las llamadas de asignación de derechos.
- Activado por
-
- Activado por
getAuthentication()
solo si el usuario no ha seleccionado ningún proveedor (MVPD) y aún no se ha autenticado. El parámetromvpds
es una matriz de proveedores disponibles para el usuario.
- Activado por
-
"setAuthenticationStatus(status, reason)"
-
Activado por
checkAuthentication()
cada vez. Activado porgetAuthentication()
solo si el usuario ya se ha autenticado y ha seleccionado un proveedor. -
El estado devuelto está autenticado o no autenticado, el motivo describe un error de autenticación o una acción de cierre de sesión.
-
-
- Se ignora en AmazonFireOS SDK y se usa el método en plataformas Android donde se activa
getAuthentication()
después de que el usuario seleccione una MVPD. El parámetrourl
proporciona la ubicación de la página de inicio de sesión de MVPD.
- Se ignora en AmazonFireOS SDK y se usa el método en plataformas Android donde se activa
-
- Activado por
checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider()
.
El parámetroevent
indica qué evento de asignación de derechos se produjo; el parámetrodata
es una lista de valores relacionados con el evento.
- Activado por
-
- Activado por
checkAuthorization()
ygetAuthorization()
tras una autorización correcta para ver un recurso. - El parámetro
token
es el token de medios de corta duración; el parámetroresource
es el contenido que el usuario tiene autorización para ver.
- Activado por
-
"tokenRequestFailed(resource, code, description)"
- Activado por
checkAuthorization()
ygetAuthorization()
tras una autorización incorrecta. - El parámetro
resource
es el contenido que el usuario intentaba ver; el parámetrocode
es el código de error que indica qué tipo de error se produjo; el parámetrodescription
describe el error asociado con el código de error.
- Activado por
-
- Activado por
getSelectedProvider()
. - El parámetro
mvpd
proporciona información sobre el proveedor seleccionado por el usuario.
- Activado por
-
"setMetadataStatus(metadata, key, arguments)"
- Activado por
getMetadata().
- El parámetro
metadata
proporciona los datos específicos solicitados; el parámetrokey
es la clave utilizada en la solicitudgetMetadata()
; y el parámetroarguments
es el mismo diccionario que se pasó agetMetadata()
.
- Activado por
-
preauthorizedResources(resources)
- Activado por
checkPreauthorizedResources()
. - El parámetro
authorizedResources
presenta los recursos que el usuario tiene autorización para ver.
- Activado por
-
B. Flujo de inicio startup_flow
-
Inicie la aplicación de nivel superior.
-
Inicie la autenticación de Adobe Pass.
-
Llame a
getInstance
para crear una sola instancia de la autenticación de Adobe PassAccessEnabler
.- Dependencia: Biblioteca Amazon FireOS nativa de autenticación de Adobe Pass (
AccessEnabler
)
- Dependencia: Biblioteca Amazon FireOS nativa de autenticación de Adobe Pass (
-
Llame a
setRequestor()
para establecer la identificación del programador; paserequestorID
del programador y (opcionalmente) una matriz de extremos de autenticación de Adobe Pass.-
Dependencia: ID de solicitante de autenticación de Adobe Pass válido (póngase en contacto con el administrador de cuentas de autenticación de Adobe Pass para organizar esto).
-
Déclencheur: setRequestorComplete() callback
-
No se pueden completar solicitudes de asignación de derechos hasta que se haya establecido completamente la identidad del solicitante. Esto significa que mientras setRequestor() sigue ejecutándose, todas las solicitudes de derechos subsiguientes (por ejemplo,
checkAuthentication()
) se bloquean.Tiene dos opciones de implementación: Una vez que la información de identificación del solicitante se envía al servidor back-end, la capa de aplicación de la interfaz de usuario puede elegir uno de los dos enfoques siguientes:
- Espere a que se active la llamada de retorno
setRequestorComplete()
(parte del delegadoAccessEnabler
). Esta opción proporciona la mayor certeza de quesetRequestor()
se completó, por lo que se recomienda para la mayoría de las implementaciones. - Continúe sin esperar a que se active la llamada de retorno
setRequestorComplete()
y comience a emitir solicitudes de asignación de derechos. Estas llamadas (checkAuthentication, checkAuthorization, getAuthentication, getAuthorization, checkPreauthorizedResource, getMetadata, logout) están en cola por la bibliotecaAccessEnabler
, que realizará las llamadas de red reales después desetRequestor()
. Esta opción se puede interrumpir ocasionalmente si, por ejemplo, la conexión de red es inestable.
-
-
Llame a checkAuthentication() para comprobar si hay una autenticación existente sin iniciar el flujo de autenticación completo. Si esta llamada se realiza correctamente, puede continuar directamente al flujo de autorización. Si no es así, continúe con el flujo de autenticación.
-
Dependencia: Una llamada correcta a
setRequestor()
(esta dependencia también se aplica a todas las llamadas subsiguientes). -
Déclencheur: setAuthenticationStatus() callback
C. Flujo de autenticación authn_flow
-
Llame a
getAuthentication()
para iniciar el flujo de autenticación o para obtener confirmación de que el usuario ya se ha autenticado.Déclencheur:
- La llamada de retorno setAuthenticationStatus(), si el usuario ya está autenticado. En este caso, continúe directamente al Flujo de autorización.
- La llamada de retorno displayProviderDialog(), si el usuario aún no se ha autenticado.
-
Presente al usuario la lista de proveedores enviados a
displayProviderDialog()
. -
Una vez que el usuario selecciona un proveedor, se abre una página WebView para que el usuario inicie sesión
note note NOTE En este punto, el usuario tiene la oportunidad de cancelar el flujo de autenticación. Si esto sucede, AccessEnabler
limpiará su estado interno y restablecerá el flujo de autenticación. -
Cuando el usuario inicie sesión correctamente, WebView se cerrará.
-
llame a
getAuthenticationToken(),
, que indica aAccessEnabler
que recupere el token de autenticación del servidor backend. -
[Opcional] Llame a
checkPreauthorizedResources(resources)
para comprobar qué recursos puede ver el usuario. El parámetroresources
es una matriz de recursos protegidos asociados al token de autenticación del usuario.Déclencheur:
preAuthorizedResources()
devolución de llamada
Punto de ejecución: después del flujo de autenticación completado -
Si la autenticación se ha realizado correctamente, continúe con el Flujo de autorización.
D. Flujo de autorización authz_flow
-
Llame a
getAuthorization()
para iniciar el flujo de autorización.Dependencia: ID de recurso válidos acordados con los MVPD.
Nota: Los ResourceID deben ser los mismos que se usan en cualquier otro dispositivo o plataforma, y serán los mismos en todas las MVPD.
-
Valide la autenticación y la autorización.
-
Si la llamada
getAuthorization()
se realiza correctamente: el usuario tiene tokens AuthN y AuthZ válidos (el usuario está autenticado y autorizado para ver los medios solicitados). -
Si
getAuthorization()
produce un error: examine la excepción generada para determinar su tipo (AuthN, AuthZ o algo más):- Si se ha producido un error de autenticación (AuthN), reinicie el flujo de autenticación.
- Si se trata de un error de autorización (AuthZ), el usuario no tiene autorización para ver los medios solicitados y se le debe mostrar algún tipo de mensaje de error.
- Si se ha producido algún otro tipo de error (error de conexión, error de red, etc.), muestre un mensaje de error apropiado al usuario.
-
-
Valide el token de medios corto.
Utilice la biblioteca del Verificador de tokens de medios de autenticación de Adobe Pass para comprobar el token de medios de corta duración devuelto desde la llamada de
getAuthorization()
anterior:- Si la validación se realiza correctamente: Reproduzca el medio solicitado para el usuario.
- Si la validación falla: El token de AuthZ no era válido, la solicitud de medios debe rechazarse y se debe mostrar un mensaje de error al usuario.
-
Vuelva al flujo normal de aplicaciones.
E. Ver flujo de medios media_flow
-
El usuario selecciona los medios que desea ver.
-
¿Están protegidos los medios? La aplicación comprueba si los medios seleccionados están protegidos:
- Si el medio seleccionado está protegido, su aplicación inicia el Flujo de autorización anterior.
- Si el medio seleccionado no está protegido, reproduzca el medio para el usuario.
F. Flujo de cierre de sesión logout_flow
-
Llame a
logout()
para cerrar la sesión del usuario.AccessEnabler
borra todos los valores en caché y tokens obtenidos por el usuario para el MVPD actual en todos los solicitantes que comparten el inicio de sesión mediante el inicio de sesión único. Después de borrar la caché,AccessEnabler
realiza una llamada al servidor para limpiar las sesiones del lado del servidor. Tenga en cuenta que, dado que la llamada al servidor podría provocar un redireccionamiento de SAML al IdP (esto permite la limpieza de la sesión en el lado del IdP), esta llamada debe seguir todas las redirecciones. Por este motivo, esta llamada se controlará dentro de un control WebView, invisible para el usuario.Nota: El flujo de cierre de sesión difiere del flujo de autenticación en que el usuario no tiene que interactuar con WebView de ninguna manera. Por lo tanto, es posible (y recomendado) hacer que el control WebView sea invisible (es decir, oculto) durante el proceso de cierre de sesión.