Cuando Looker está incorporado en un iframe con la incorporación firmada, algunos navegadores usan de forma predeterminada una política de cookies que bloquea las cookies de terceros. Las cookies de terceros se rechazan cuando el iframe incorporado se carga desde un dominio diferente del que carga la aplicación de incorporación. Por lo general, puedes evitar esta limitación solicitando y usando un dominio personalizado. Sin embargo, estos dominios no se pueden usar en algunas situaciones. En estas situaciones, se puede usar la incorporación sin cookies de Looker.
¿Cómo funciona la incorporación sin cookies?
Cuando no se bloquean las cookies de terceros, se crea una cookie de sesión cuando un usuario accede inicialmente a Looker. Esta cookie se envía con cada solicitud de usuario, y el servidor de Looker la usa para establecer la identidad del usuario que inició la solicitud. Cuando se bloquean las cookies, la cookie no se envía con una solicitud, por lo que el servidor de Looker no puede identificar al usuario asociado con la solicitud.
Para resolver este problema, la incorporación sin cookies de Looker asocia tokens con cada solicitud que se puede usar para recrear la sesión de usuario en el servidor de Looker. Es responsabilidad de la aplicación de incorporación obtener estos tokens y ponerlos a disposición de la instancia de Looker que se ejecuta en el iframe incorporado. El proceso para obtener y proporcionar estos tokens se describe en el resto de este documento.
Para usar cualquiera de las APIs, la aplicación de incorporación debe poder autenticarse en la API de Looker con privilegios de administrador. El dominio de incorporación también debe aparecer en la lista de entidades permitidas del dominio de incorporación o, si usas Looker 23.8 o una versión posterior, se puede incluir cuando se adquiere la sesión sin cookies.
Cómo crear un iframe de incorporación de Looker
En el siguiente diagrama de secuencias, se ilustra la creación de un iframe de incorporación. Se pueden generar varios iframes de forma simultánea o en algún momento en el futuro. Cuando se implemente correctamente, el iframe se unirá automáticamente a la sesión creada por el primer iframe. El SDK de Looker Embed simplifica este proceso, ya que une automáticamente la sesión existente.
- El usuario realiza una acción en la aplicación de incorporación que da como resultado la creación de un iframe de Looker.
- El cliente de la aplicación de incorporación adquiere una sesión de Looker. El SDK de Looker Embed se puede usar para iniciar esta sesión, pero se debe proporcionar una URL de extremo o una función de devolución de llamada. Si se usa una función de devolución de llamada, llamará al servidor de aplicaciones de incorporación para adquirir la sesión de incorporación de Looker. De lo contrario, el SDK de Embed llamará a la URL de extremo proporcionada.
- El servidor de aplicaciones de incorporación usa la API de Looker para adquirir una sesión de incorporación. Esta llamada a la API es similar al proceso de firma de incorporaciones firmadas de Looker, ya que acepta la definición del usuario de incorporación como entrada. Si ya existe una sesión de incorporación de Looker para el usuario que llama, el token de referencia de la sesión asociado se debe incluir en la llamada. Esto se explica con más detalle en la sección Adquirir sesión de este documento.
- El procesamiento del extremo de sesión de incorporación de adquisición es similar al extremo
/login/embed/{signed url)firmado, ya que espera la definición del usuario incorporada de Looker como el cuerpo de la solicitud, en lugar de la URL. El proceso de adquisición del extremo de sesión de incorporación valida y crea o actualiza el usuario de incorporación. También puede aceptar un token de referencia de sesión existente. Esto es importante, ya que permite que varios iframes incorporados de Looker compartan la misma sesión. El usuario de incorporación no se actualizará si se proporciona un token de referencia de sesión y la sesión no ha vencido. Esto admite el caso de uso en el que se crea un iframe con una URL de incorporación firmada y otros iframes se crean sin una URL de incorporación firmada. En este caso, los iframes sin URLs de incorporación firmadas heredarán la cookie de la primera sesión. - La llamada a la API de Looker muestra cuatro tokens, cada uno con un tiempo de actividad (TTL):
- Token de autorización (TTL = 30 segundos)
- Token de navegación (TTL = 10 minutos)
- Token de API (TTL = 10 minutos)
- Token de referencia de sesión (TTL = vida útil restante de la sesión)
- El servidor de aplicaciones de incorporación debe realizar un seguimiento de los datos que muestran los datos de Looker y asociarlos con el usuario que realiza la llamada y con el usuario-agente del navegador del usuario que realiza la llamada. Encontrarás sugerencias para hacerlo en la sección Generar tokens de este documento. Esta llamada mostrará el token de autorización, un token de navegación y un token de API, junto con todos los TTL asociados. El token de referencia de la sesión debe estar protegido y no exponerse en el navegador que realiza la llamada.
Una vez que los tokens se devuelvan al navegador, se debe crear una URL de acceso incorporada de Looker. El SDK de Looker Embed creará automáticamente la URL de acceso incorporada. Si quieres usar la API de
windows.postMessagepara crear la URL de acceso incorporada, consulta la sección Usa la API dewindows.postMessagede Looker de este documento para ver ejemplos.La URL de acceso no contiene los detalles del usuario de incorporación firmado. Contiene el URI de destino, incluido el token de navegación y el token de autorización como parámetro de consulta. El token de autorización se debe usar dentro de los 30 segundos y solo se puede usar una vez. Si se requieren iframes adicionales, se debe volver a adquirir una sesión de incorporación. Sin embargo, si se proporciona el token de referencia de sesión, el token de autorización se asociará con la misma sesión.
El extremo de acceso de incorporación de Looker determina si el acceso es para la incorporación sin cookies, lo que se indica por la presencia del token de autorización. Si el token de autorización es válido, se verifica lo siguiente:
- La sesión asociada sigue siendo válida.
- El usuario de incorporación asociado aún es válido.
- El usuario-agente del navegador asociado a la solicitud coincide con el agente del navegador asociado con la sesión.
Si se aprueban las verificaciones del paso anterior, la solicitud se redirecciona con el URI de destino contenido en la URL. Este es el mismo proceso que se realiza para el acceso a la incorporación firmada de Looker.
Esta solicitud es el redireccionamiento para iniciar el panel de Looker. Esta solicitud tendrá el token de navegación como parámetro.
Antes de que se ejecute el extremo, el servidor de Looker busca el token de navegación en la solicitud. Si el servidor encuentra el token, verifica lo siguiente:
- La sesión asociada sigue siendo válida.
- El usuario-agente del navegador asociado a la solicitud coincide con el agente del navegador asociado con la sesión.
Si es válida, la sesión se restablece para la solicitud y se ejecuta la solicitud del panel.
El código HTML para cargar el panel se devuelve al iframe.
La IU de Looker que se ejecuta en el iframe determina que el HTML del panel es una respuesta de incorporación sin cookies. En ese momento, la IU de Looker envía un mensaje a la aplicación de incorporación para solicitar los tokens recuperados en el paso 6. Luego, la IU espera hasta recibir los tokens. Si los tokens no llegan, se mostrará un mensaje.
La aplicación de incorporación envía los tokens al iframe incorporado de Looker.
Cuando se reciben los tokens, la IU de Looker que se ejecuta en el iframe inicia el proceso para renderizar el objeto de solicitud. Durante este proceso, la IU realizará llamadas a la API al servidor de Looker. El token de API que se recibió en el paso 15 se inserta automáticamente como un encabezado en todas las solicitudes de la API.
Antes de que se ejecute cualquier extremo, el servidor de Looker busca el token de API en la solicitud. Si el servidor encuentra el token, verifica lo siguiente:
- La sesión asociada sigue siendo válida.
- El usuario-agente del navegador asociado a la solicitud coincide con el agente del navegador asociado con la sesión.
Si la sesión es válida, se restablece para la solicitud y se ejecuta la solicitud a la API.
Se muestran los datos del panel.
Se renderiza el panel.
El usuario tiene el control del panel.
Genera tokens nuevos
En el siguiente diagrama de secuencias, se ilustra la generación de tokens nuevos.
- La IU de Looker que se ejecuta en el iframe incorporado supervisa el TTL de los tokens de incorporación.
- Cuando los tokens se acercan al vencimiento, la IU de Looker envía un mensaje de token de actualización al cliente de la aplicación de incorporación.
- Luego, el cliente de la aplicación de incorporación solicita nuevos tokens desde un extremo que se implementa en el servidor de la aplicación de incorporación. El SDK de Looker Embed solicitará nuevos tokens automáticamente, pero se deberá proporcionar la URL de extremo o una función de devolución de llamada. Si se utiliza la función de devolución de llamada, llamará al servidor de la aplicación de incorporación para generar tokens nuevos. De lo contrario, el SDK de Embed llamará a la URL de extremo proporcionada.
- La aplicación de incorporación encuentra el
session_reference_tokenasociado con la sesión de incorporación. El ejemplo que se proporciona en el repositorio de Git del SDK de Looker Embed usa cookies de sesión, pero también se puede usar una caché distribuida del servidor, como Redis. - El servidor de aplicaciones de incorporación llama al servidor de Looker con una solicitud para generar tokens. Esta solicitud también requiere API recientes y tokens de navegación, además del usuario-agente del navegador que inició la solicitud.
- El servidor de Looker valida el usuario-agente, el token de referencia de la sesión, el token de navegación y el token de la API. Si la solicitud es válida, se generan tokens nuevos.
- Los tokens se devuelven al servidor de la aplicación de incorporación que realiza la llamada.
- El servidor de aplicaciones de incorporación quita el token de referencia de la sesión de la respuesta y le muestra la respuesta restante al cliente de la aplicación de incorporación.
- El cliente de la aplicación de incorporación envía los tokens recién generados a la IU de Looker. El SDK de Looker Embed lo hará automáticamente. Los clientes de aplicaciones incorporados que usen la API de
windows.postMessageserán responsables de enviar los tokens. Una vez que la IU de Looker reciba los tokens, se usarán en llamadas a la API y navegaciones de páginas posteriores.
Implementa la incorporación sin cookies de Looker
La incorporación sin cookies de Looker se puede implementar mediante el SDK de Looker Embed o la API de windows.postMessage. El método que usa el SDK de Looker Embed es más fácil, pero también hay un ejemplo que muestra cómo usar la API de windows.postMessage. Puedes encontrar explicaciones detalladas de ambas implementaciones en el archivo README del SDK de Embed de Looker. El repositorio de Git del SDK de incorporación también contiene implementaciones activas.
Configura la instancia de Looker
La incorporación sin cookies tiene características en común con la incorporación firmada de Looker. La incorporación sin cookies depende de que se habilite la autenticación de SSO incorporada. Sin embargo, a diferencia de la incorporación firmada de Looker, la incorporación sin cookies no usa el parámetro de configuración Incorporar Secret. La incorporación sin cookies usa un token web JSON (JWT) con forma de configuración de Secreto de JWT incorporada, que se puede establecer o restablecer en la página Incorporar en la sección Plataforma del menú Administrador.
No es obligatorio configurar el secreto de JWT, ya que el primer intento de crear una sesión de incorporación sin cookies sí lo hará. No restablezcas este token, ya que se invalidarán todas las sesiones de incorporación activas sin cookies.
A diferencia del secreto de incorporación, el secreto de JWT incorporado nunca se expone, ya que solo se usa de forma interna en el servidor de Looker.
Implementación en cliente de aplicación
Esta sección incluye ejemplos de cómo implementar la incorporación sin cookies en el cliente de la aplicación y contiene las siguientes subsecciones:
- Instala y actualiza el SDK de Looker Embed
- Usa el SDK de Looker Embed
- Usa la API de
windows.postMessagede Looker
Instala o actualiza el SDK de Looker Embed
Las siguientes versiones del SDK de Looker son obligatorias para usar la incorporación sin cookies:
@looker/embed-sdk >= 1.8
@looker/sdk >= 22.16.0
Usa el SDK de Looker Embed
Para iniciar la sesión sin cookies, se agregó un nuevo método de inicialización al SDK de Embed. Este método acepta dos cadenas de URL o dos funciones de devolución de llamada. Las cadenas de URL deben hacer referencia a los extremos del servidor de aplicaciones de incorporación. Los detalles de implementación de estos extremos en el servidor de aplicaciones se abordan en la sección Implementación del servidor de aplicaciones de este documento.
LookerEmbedSDK.initCookieless(
runtimeConfig.lookerHost,
'/acquire-embed-session',
'/generate-embed-tokens'
)
En el siguiente ejemplo, se muestra cómo se usan las devoluciones de llamada. Las devoluciones de llamada solo se deben usar cuando sea necesario que la aplicación cliente de incorporación conozca el estado de la sesión de incorporación de Looker. También puedes usar el evento session:status, por lo que no es necesario usar devoluciones de llamada con el SDK de Embed.
const acquireEmbedSessionCallback =
async (): Promise<LookerEmbedCookielessSessionData> => {
const resp = await fetch('/acquire-embed-session')
if (!resp.ok) {
console.error('acquire-embed-session failed', { resp })
throw new Error(
`acquire-embed-session failed: ${resp.status} ${resp.statusText}`
)
}
return (await resp.json()) as LookerEmbedCookielessSessionData
}
const generateEmbedTokensCallback =
async (): Promise<LookerEmbedCookielessSessionData> => {
const { api_token, navigation_token } = getApplicationTokens() || {}
const resp = await fetch('/generate-embed-tokens', {
method: 'PUT',
headers: { 'content-type': 'application/json' },
body: JSON.stringify({ api_token, navigation_token }),
})
if (!resp.ok) {
if (resp.status === 400) {
return { session_reference_token_ttl: 0 }
}
console.error('generate-embed-tokens failed', { resp })
throw new Error(
`generate-embed-tokens failed: ${resp.status} ${resp.statusText}`
)
}
return (await resp.json()) as LookerEmbedCookielessSessionData
}
LookerEmbedSDK.initCookieless(
runtimeConfig.lookerHost,
acquireEmbedSessionCallback,
generateEmbedTokensCallback
)
Usa la API de Looker windows.postMessage
Puedes ver un ejemplo detallado del uso de la API de windows.postMessage en los archivos message_example.ts y message_utils.ts del repositorio de Git del SDK de incorporación. Aquí se detallan los aspectos destacados del ejemplo.
En el siguiente ejemplo se muestra cómo compilar la URL para el iframe. La función de devolución de llamada es idéntica al ejemplo de acquireEmbedSessionCallback que se vio antes.
private async getCookielessLoginUrl(): Promise<string> {
const { authentication_token, navigation_token } =
await this.embedEnvironment.acquireSession()
const url = this.embedUrl.startsWith('/embed')
? this.embedUrl
: `/embed${this.embedUrl}`
const embedUrl = new URL(url, this.frameOrigin)
if (!embedUrl.searchParams.has('embed_domain')) {
embedUrl.searchParams.set('embed_domain', window.location.origin)
}
embedUrl.searchParams.set('embed_navigation_token', navigation_token)
const targetUri = encodeURIComponent(
`${embedUrl.pathname}${embedUrl.search}${embedUrl.hash}`
)
return `${embedUrl.origin}/login/embed/${targetUri}?embed_authentication_token=${authentication_token}`
}
En el siguiente ejemplo, se muestra cómo escuchar las solicitudes de tokens, generar tokens nuevos y enviarlos a Looker. La función de devolución de llamada es idéntica al ejemplo anterior de generateEmbedTokensCallback.
this.on(
'session:tokens:request',
this.sessionTokensRequestHandler.bind(this)
)
private connected = false
private async sessionTokensRequestHandler(_data: any) {
const contentWindow = this.getContentWindow()
if (contentWindow) {
if (!this.connected) {
// When not connected the newly acquired tokens can be used.
const sessionTokens = this.embedEnvironment.applicationTokens
if (sessionTokens) {
this.connected = true
this.send('session:tokens', this.embedEnvironment.applicationTokens)
}
} else {
// If connected, the embedded Looker application has decided that
// it needs new tokens. Generate new tokens.
const sessionTokens = await this.embedEnvironment.generateTokens()
this.send('session:tokens', sessionTokens)
}
}
}
send(messageType: string, data: any = {}) {
const contentWindow = this.getContentWindow()
if (contentWindow) {
const message: any = {
type: messageType,
...data,
}
contentWindow.postMessage(JSON.stringify(message), this.frameOrigin)
}
return this
}
Implementación del servidor de aplicaciones
Esta sección incluye ejemplos de cómo implementar la incorporación sin cookies en el servidor de aplicaciones y contiene las siguientes subsecciones:
Implementación básica
La aplicación de incorporación es necesaria para implementar dos extremos del servidor que invocarán extremos de Looker. Esto permite garantizar que el token de referencia de la sesión permanezca seguro. Estos son los extremos:
- Adquirir sesión: Si ya existe un token de referencia de sesión y sigue activo, las solicitudes de una sesión se unirán a la sesión existente. Se llama a la sesión de adquisición cuando se crea un iframe.
- Generar tokens: Looker activa llamadas a este extremo de forma periódica.
Adquirir sesión
Este ejemplo en TypeScript usa la sesión para guardar o restablecer el token de referencia de sesión. No es necesario implementar el extremo en TypeScript.
app.get(
'/acquire-embed-session',
async function (req: Request, res: Response) {
try {
const current_session_reference_token =
req.session && req.session.session_reference_token
const response = await acquireEmbedSession(
req.headers['user-agent']!,
user,
current_session_reference_token
)
const {
authentication_token,
authentication_token_ttl,
navigation_token,
navigation_token_ttl,
session_reference_token,
session_reference_token_ttl,
api_token,
api_token_ttl,
} = response
req.session!.session_reference_token = session_reference_token
res.json({
api_token,
api_token_ttl,
authentication_token,
authentication_token_ttl,
navigation_token,
navigation_token_ttl,
session_reference_token_ttl,
})
} catch (err: any) {
res.status(400).send({ message: err.message })
}
}
)
async function acquireEmbedSession(
userAgent: string,
user: LookerEmbedUser,
session_reference_token: string
) {
await acquireLookerSession()
try {
const request = {
...user,
session_reference_token: session_reference_token,
}
const sdk = new Looker40SDK(lookerSession)
const response = await sdk.ok(
sdk.acquire_embed_cookieless_session(request, {
headers: {
'User-Agent': userAgent,
},
})
)
return response
} catch (error) {
console.error('embed session acquire failed', { error })
throw error
}
}
A partir de Looker 23.8, el dominio incorporado se puede incluir cuando se adquiere la sesión sin cookies. Esta es una alternativa a agregar el dominio de incorporación con el panel Administrador > Incorporar de Looker. Looker guarda el dominio incorporado en la base de datos interna de Looker, por lo que no se mostrará en el panel Administrador > Incorporar. En cambio, el dominio incorporado está asociado a la sesión sin cookies y existe solo durante la sesión. Consulta las prácticas recomendadas de seguridad si decides aprovechar esta función.
Generar tokens
Este ejemplo en TypeScript usa la sesión para guardar o restablecer el token de referencia de sesión. No es necesario implementar el extremo en TypeScript.
Es importante que sepas cómo manejar las respuestas 400, que ocurren cuando los tokens no son válidos. No debería ocurrir una respuesta 400, pero, si sucede, la práctica recomendada es finalizar la sesión de incorporación de Looker. Para finalizar la sesión de incorporación de Looker, destruye el iframe de incorporación o establece el valor de session_reference_token_ttl en cero en el mensaje session:tokens. Si estableces el valor de session_reference_token_ttl en cero, el iframe de Looker mostrará un diálogo de sesión vencida.
No se devuelve una respuesta 400 cuando vence la sesión de incorporación. Si la sesión de incorporación venció, se devuelve una respuesta 200 con el valor session_reference_token_ttl establecido en cero.
app.put(
'/generate-embed-tokens',
async function (req: Request, res: Response) {
try {
const session_reference_token = req.session!.session_reference_token
const { api_token, navigation_token } = req.body as any
const tokens = await generateEmbedTokens(
req.headers['user-agent']!,
session_reference_token,
api_token,
navigation_token
)
res.json(tokens)
} catch (err: any) {
res.status(400).send({ message: err.message })
}
}
)
}
async function generateEmbedTokens(
userAgent: string,
session_reference_token: string,
api_token: string,
navigation_token: string
) {
if (!session_reference_token) {
console.error('embed session generate tokens failed')
// missing session reference treat as expired session
return {
session_reference_token_ttl: 0,
}
}
await acquireLookerSession()
try {
const sdk = new Looker40SDK(lookerSession)
const response = await sdk.ok(
sdk.generate_tokens_for_cookieless_session(
{
api_token,
navigation_token,
session_reference_token: session_reference_token || '',
},
{
headers: {
'User-Agent': userAgent,
},
}
)
)
return {
api_token: response.api_token,
api_token_ttl: response.api_token_ttl,
navigation_token: response.navigation_token,
navigation_token_ttl: response.navigation_token_ttl,
session_reference_token_ttl: response.session_reference_token_ttl,
}
} catch (error: any) {
if (error.message?.includes('Invalid input tokens provided')) {
// Currently the Looker UI does not know how to handle bad
// tokens. This should not happen but if it does expire the
// session. If the token is bad there is not much that that
// the Looker UI can do.
return {
session_reference_token_ttl: 0,
}
}
console.error('embed session generate tokens failed', { error })
throw error
}
Consideraciones sobre la implementación
La aplicación de incorporación debe realizar un seguimiento del token de referencia de la sesión y debe mantenerlo protegido. Este token debe estar asociado con el usuario de la aplicación incorporada. El token de aplicación de incorporación se puede almacenar de una de las siguientes maneras:
- En la sesión del usuario de la aplicación incorporada
- En una caché del servidor que esté disponible en un entorno agrupado en clústeres
- En una tabla de base de datos asociada con el usuario
Si la sesión se almacena como una cookie, esta debe estar encriptada. En el ejemplo del repositorio del SDK de incorporación, se usa una cookie de sesión para almacenar el token de referencia de sesión.
Cuando venza la sesión de incorporación de Looker, se mostrará un diálogo en el iframe incorporado. En este punto, el usuario no podrá realizar ninguna acción en la instancia incorporada. Cuando esto ocurra, se generarán los eventos session:status, lo que permitirá que la aplicación de incorporación detecte el estado actual de la aplicación incorporada de Looker y realice algún tipo de acción.
Una aplicación de incorporación puede detectar si la sesión de incorporación caducó. Para ello, verifica si el valor session_reference_token_ttl que muestra el extremo generate_tokens es cero. Si el valor es cero, quiere decir que caducó la sesión de incorporación. Considera usar una función de devolución de llamada para generar tokens cuando se inicialice la incorporación sin cookies. La función de devolución de llamada puede determinar si la sesión de incorporación venció y destruirá el iframe incorporado como alternativa al uso del diálogo predeterminado de vencimiento de la sesión incorporada.
Ejecuta el ejemplo de incorporación sin cookies de Looker
El repositorio del SDK de incorporación contiene un servidor y un cliente exprés de nodos simples escritos en TypeScript que implementa una aplicación de incorporación simple. Los ejemplos que se muestran con anterioridad se toman de esta implementación. A continuación, se supone que tu instancia de Looker se configuró para usar la incorporación sin cookies, como se describió anteriormente.
Puedes ejecutar el servidor de la siguiente manera:
- Clona el repositorio del SDK de Embed:
git clone git@github.com:looker-open-source/embed-sdk.git - Cambia el directorio:
cd embed-sdk - Instala las dependencias:
npm install - Configura el servidor, como se muestra en la sección Configura el servidor de este documento.
- Ejecuta el servidor:
npm run server
Configura el servidor
Crea un archivo .env en la raíz del repositorio clonado (esto se incluye en .gitignore).
El formato es el siguiente:
LOOKER_EMBED_HOST=your-looker-instance-url.com.
LOOKER_EMBED_API_URL=https://your-looker-instance-url.com
LOOKER_DEMO_HOST=localhost
LOOKER_DEMO_PORT=8080
LOOKER_EMBED_SECRET=embed-secret-from-embed-admin-page
LOOKER_CLIENT_ID=client-id-from-user-admin-page
LOOKER_CLIENT_SECRET=client-secret-from-user-admin-page
LOOKER_DASHBOARD_ID=id-of-dashboard
LOOKER_LOOK_ID=id-of-look
LOOKER_EXPLORE_ID=id-of-explore
LOOKER_EXTENSION_ID=id-of-extension
LOOKER_VERIFY_SSL=true