Quando o Looker é incorporado a um iframe usando incorporação assinada, alguns navegadores adotam uma política de cookies que bloqueia cookies de terceiros. Cookies de terceiros são rejeitados quando o iframe incorporado é carregado de um domínio diferente daquele que carrega o aplicativo de incorporação. Em geral, é possível contornar essa limitação solicitando e usando um domínio curto. No entanto, os domínios curtos não podem ser usados em alguns cenários. É nesses cenários que a incorporação sem cookies do Looker pode ser usada.
Como funciona a incorporação sem cookies?
Quando os cookies de terceiros não são bloqueados, um cookie de sessão é criado quando um usuário faz login no Looker pela primeira vez. Esse cookie é enviado com todas as solicitações do usuário, e o servidor do Looker o utiliza para estabelecer a identidade do usuário que iniciou a solicitação. Quando os cookies são bloqueados, eles não são enviados com uma solicitação. Por isso, o servidor do Looker não consegue identificar o usuário associado à solicitação.
Para resolver esse problema, a incorporação sem cookies do Looker associa tokens a cada solicitação que podem ser usados para recriar a sessão do usuário no servidor do Looker. É responsabilidade do aplicativo de incorporação conseguir esses tokens e disponibilizá-los para a instância do Looker em execução no iframe incorporado. O processo de recebimento e fornecimento desses tokens é descrito no restante deste documento.
Para usar uma das APIs, o aplicativo de incorporação precisa ser autenticado na API Looker com privilégios de administrador. O domínio de incorporação também precisa estar listado na Lista de permissões de domínios de incorporação. Se você estiver usando o Looker 23.8 ou uma versão mais recente, ele poderá ser incluído quando a sessão sem cookies for adquirida.
Como criar um iframe de incorporação do Looker
O diagrama de sequência a seguir ilustra a criação de um iframe incorporado. Vários iframes podem ser gerados simultaneamente ou em algum momento no futuro. Quando implementado corretamente, o iframe entra automaticamente na sessão criada pelo primeiro iframe. O SDK de incorporação do Looker simplifica esse processo ao ingressar automaticamente na sessão atual.
- O usuário realiza uma ação no aplicativo de incorporação que resulta na criação de um iframe do Looker.
- O cliente do aplicativo de incorporação adquire uma sessão do Looker. O SDK de incorporação do Looker pode ser usado para iniciar essa sessão, mas é necessário fornecer um URL de endpoint ou uma função de callback. Se uma função de callback for usada, ela vai chamar o servidor de aplicativos de incorporação para adquirir a sessão de incorporação do Looker. Caso contrário, o SDK de incorporação chamará o URL do endpoint fornecido.
- O servidor de aplicativos de incorporação usa a API Looker para adquirir uma sessão de incorporação. Essa chamada de API é semelhante ao processo de assinatura de incorporação assinada do Looker, já que aceita a definição do usuário incorporado como entrada. Se já houver uma sessão de incorporação do Looker para o usuário que fez a chamada, o token de referência da sessão associada vai precisar ser incluído na chamada. Isso será explicado com mais detalhes na seção Adquirir sessão deste documento.
- O processamento do endpoint da sessão de aquisição de aquisição é semelhante ao endpoint
/login/embed/{signed url)assinado, porque espera a definição do usuário de incorporação do Looker como o corpo da solicitação, e não no URL. O processo de endpoint da sessão de aquisição de incorporação valida e cria ou atualiza o usuário de incorporação. Ele também pode aceitar um token de referência de sessão atual. Isso é importante porque permite que vários iframes incorporados do Looker compartilhem a mesma sessão. O usuário incorporado não será atualizado se um token de referência de sessão for fornecido e a sessão não tiver expirado. Isso oferece suporte ao caso de uso em que um iframe é criado usando um URL de incorporação assinado e outros iframes são criados sem um URL de incorporação assinado. Nesse caso, os iframes sem URLs incorporados assinados vão herdar o cookie da primeira sessão. - A chamada da API Looker retorna quatro tokens, cada um com um time to live (TTL):
- Token de autorização (TTL = 30 segundos)
- Token de navegação (TTL = 10 minutos)
- Token de API (TTL = 10 minutos)
- Token de referência da sessão (TTL = ciclo de vida restante da sessão)
- O servidor de aplicativos de incorporação precisa monitorar os dados retornados pelos dados do Looker e associá-los ao usuário que fez a chamada e ao user agent do navegador do usuário que fez a chamada. Sugestões para fazer isso são fornecidas na seção Gerar tokens deste documento. Essa chamada vai retornar os tokens de autorização, de navegação e de API, além de todos os TTLs associados. O token de referência da sessão precisa ser protegido e não exposto no navegador que faz a chamada.
Depois que os tokens forem retornados para o navegador, será necessário criar um URL de login de incorporação do Looker. O SDK de incorporação do Looker vai criar o URL de login de incorporação automaticamente. Se quiser usar a API
windows.postMessagepara criar o URL de login de incorporação, consulte a seção Como usar a API Lookerwindows.postMessagedeste documento.O URL de login não contém os detalhes do usuário de incorporação assinado. Ele contém o URI de destino, incluindo o token de navegação e o token de autorização como um parâmetro de consulta. O token de autorização precisa ser usado em até 30 segundos e só pode ser utilizado uma vez. Se iframes adicionais forem necessários, será necessário adquirir uma sessão de incorporação novamente. No entanto, se o token de referência de sessão for fornecido, o token de autorização será associado à mesma sessão.
O endpoint de login de incorporação do Looker determina se o login é para incorporação sem cookies, o que é indicado pela presença do token de autorização. Se o token de autorização for válido, ele verificará o seguinte:
- A sessão associada ainda é válida.
- O usuário de incorporação associado ainda é válido.
- O user agent do navegador associado à solicitação corresponde ao associado à sessão.
Se as verificações da etapa anterior forem aprovadas, a solicitação será redirecionada usando o URI de destino contido no URL. O processo é igual ao de login de incorporação assinada pelo Looker.
Essa solicitação é o redirecionamento para abrir o painel do Looker. Essa solicitação terá o token de navegação como parâmetro.
Antes da execução do endpoint, o servidor do Looker procura o token de navegação na solicitação. Se o servidor encontrar o token, ele verificará o seguinte:
- A sessão associada ainda é válida.
- O user agent do navegador associado à solicitação corresponde ao associado à sessão.
Se for válido, a sessão será restaurada para a solicitação e a solicitação do painel será executada.
O HTML para carregar o painel é retornado ao iframe.
A interface do Looker em execução no iframe determina que o HTML do painel é uma resposta de incorporação sem cookies. Nesse momento, a interface do Looker envia uma mensagem ao aplicativo de incorporação solicitando os tokens recuperados na etapa 6. A interface espera até receber os tokens. Se os tokens não chegarem, uma mensagem será exibida.
O aplicativo de incorporação envia os tokens ao iframe incorporado do Looker.
Quando os tokens são recebidos, a interface do Looker em execução no iframe inicia o processo de renderização do objeto de solicitação. Durante esse processo, a UI faz chamadas de API para o servidor do Looker. O token de API recebido na etapa 15 é automaticamente injetado como um cabeçalho em todas as solicitações de API.
Antes de executar qualquer endpoint, o servidor do Looker procura o token de API na solicitação. Se o servidor encontrar o token, ele verificará o seguinte:
- A sessão associada ainda é válida.
- O user agent do navegador associado à solicitação corresponde ao associado à sessão.
Se a sessão for válida, ela será restaurada para a solicitação e a solicitação de API será executada.
Os dados do painel são retornados.
O painel foi renderizado.
O usuário tem controle sobre o painel.
Como gerar novos tokens
O diagrama de sequência a seguir ilustra a geração de novos tokens.
- A interface do Looker em execução no iframe incorporado monitora o TTL dos tokens de incorporação.
- Quando os tokens se aproximam do vencimento, a interface do Looker envia uma mensagem de token de atualização para o cliente do aplicativo de incorporação.
- O cliente do aplicativo de incorporação solicita novos tokens de um endpoint que é implementado no servidor de aplicativos de incorporação. O SDK de incorporação do Looker vai solicitar novos tokens automaticamente, mas o URL do endpoint ou uma função de callback precisa ser fornecido. Se a função de callback for usada, ela vai chamar o servidor de aplicativos de incorporação para gerar novos tokens. Caso contrário, o SDK de incorporação chamará o URL do endpoint fornecido.
- O aplicativo de incorporação encontra o
session_reference_tokenassociado à sessão de incorporação. O repositório Git do SDK de incorporação do Looker usa cookies de sessão, mas um cache distribuído do lado do servidor, como o Redis, também pode ser usado. - O servidor de aplicativos de incorporação chama o servidor do Looker com uma solicitação para gerar tokens. Essa solicitação também requer uma API e tokens de navegação recentes, além do user agent do navegador que iniciou a solicitação.
- O servidor do Looker valida o user agent, o token de referência da sessão, o token de navegação e o token da API. Se a solicitação for válida, novos tokens serão gerados.
- Os tokens são retornados ao servidor de aplicativos de incorporação de chamada.
- O servidor de aplicativo de incorporação remove o token de referência de sessão da resposta e retorna a resposta restante ao cliente do aplicativo de incorporação.
- O cliente do aplicativo de incorporação envia os tokens gerados recentemente para a interface do Looker. O SDK de incorporação do Looker vai fazer isso automaticamente. Os clientes de aplicativos de incorporação que usam a API
windows.postMessageserão responsáveis pelo envio dos tokens. Quando a interface do Looker receber os tokens, eles serão usados nas próximas chamadas de API e navegações nas páginas.
Implementar a incorporação sem cookies do Looker
A incorporação sem cookies do Looker pode ser implementada usando o SDK de incorporação do Looker ou a API windows.postMessage. O método que usa o SDK de incorporação do Looker é mais fácil, mas também há um exemplo que mostra como usar a API windows.postMessage. Explicações detalhadas de ambas as implementações podem ser encontradas no arquivo README do SDK de incorporação do Looker. O repositório git do SDK de incorporação também contém implementações funcionais.
Como configurar a instância do Looker
A incorporação sem cookies é semelhante à incorporação assinada do Looker. A incorporação sem cookies depende da ativação da autenticação SSO de incorporação. No entanto, diferentemente da incorporação assinada pelo Looker, a incorporação sem cookies não usa a configuração Embed Secret. A incorporação sem cookies usa um JSON Web Token (JWT) na forma de uma configuração Incorporar Secret JWT, que pode ser definida ou redefinida na página Incorporar na seção Plataforma do menu Administrador.
A definição do secret JWT não é obrigatória, já que a primeira tentativa de criar uma sessão de incorporação sem cookies vai gerar o JWT. Evite redefinir esse token. Isso vai invalidar todas as sessões de incorporação sem cookies ativas.
Ao contrário do secret de incorporação, o secret JWT de incorporação nunca é exposto, porque só é usado internamente no servidor do Looker.
Implementação do cliente do aplicativo
Esta seção inclui exemplos de como implementar a incorporação sem cookies no cliente do aplicativo e contém as seguintes subseções:
- Como instalar e atualizar o SDK de incorporação do Looker
- Como usar o SDK incorporado do Looker
- Como usar a API Looker
windows.postMessage
Instalar ou atualizar o SDK de incorporação do Looker
As seguintes versões do SDK do Looker são obrigatórias para usar a incorporação sem cookies:
@looker/embed-sdk >= 1.8
@looker/sdk >= 22.16.0
Como usar o SDK de incorporação do Looker
Um novo método de inicialização foi adicionado ao SDK de incorporação para iniciar a sessão sem cookies. Esse método aceita duas strings de URL ou duas funções de callback. As strings de URL precisam fazer referência a endpoints no servidor de aplicativos incorporado. Os detalhes sobre a implementação desses endpoints no servidor de aplicativos são abordados na seção Implementação do servidor de aplicativos deste documento.
LookerEmbedSDK.initCookieless(
runtimeConfig.lookerHost,
'/acquire-embed-session',
'/generate-embed-tokens'
)
O exemplo a seguir mostra como os callbacks são usados. Os callbacks só podem ser usados quando for necessário que o aplicativo cliente de embedding esteja ciente do status da sessão de incorporação do Looker. Também é possível usar o evento session:status, o que torna desnecessário o uso de callbacks com o SDK de incorporação.
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
)
Como usar a API Looker windows.postMessage
Você pode conferir um exemplo detalhado de uso da API windows.postMessage nos arquivos message_example.ts e message_utils.ts no repositório Git do SDK de incorporação. Os destaques do exemplo estão detalhados aqui.
O exemplo a seguir demonstra como criar o URL para o iframe. A função de callback é idêntica ao exemplo de acquireEmbedSessionCallback visto anteriormente.
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}`
}
O exemplo a seguir demonstra como detectar solicitações de token, gerar novos tokens e enviá-los ao Looker. A função de callback é idêntica ao exemplo de generateEmbedTokensCallback anterior.
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
}
Implementação do servidor de aplicativos
Esta seção inclui exemplos de como implementar a incorporação sem cookies no servidor de aplicativos e contém as seguintes subseções:
Implementação básica
O aplicativo de incorporação precisa implementar dois endpoints do lado do servidor que vão invocar endpoints do Looker. Isso garante a segurança do token de referência da sessão. Estes são os endpoints:
- Adquirir sessão: se um token de referência de sessão já existe e ainda está ativo, as solicitações para uma sessão ingressam na sessão existente. A sessão de aquisição é chamada quando um iframe é criado.
- Gerar tokens: o Looker aciona chamadas para esse endpoint periodicamente.
Adquirir sessão
Este exemplo no TypeScript usa a sessão para salvar ou restaurar o token de referência da sessão. O endpoint não precisa ser implementado no 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 do Looker 23.8, o domínio incorporado poderá ser incluído quando a sessão sem cookies for adquirida. Essa é uma alternativa à adição do domínio incorporado usando o painel Administrador > Incorporar do Looker. O Looker salva o domínio incorporado no banco de dados interno do Looker. Por isso, ele não vai aparecer no painel Administrador > Incorporar. Em vez disso, o domínio incorporado é associado à sessão sem cookies e existe somente durante a sessão. Analise as práticas recomendadas de segurança se decidir aproveitar esse recurso.
Gerar tokens
Este exemplo no TypeScript usa a sessão para salvar ou restaurar o token de referência da sessão. O endpoint não precisa ser implementado no TypeScript.
É importante que você saiba lidar com 400 respostas, que ocorrem quando os tokens são inválidos. Não deveria acontecer uma resposta 400, mas, se isso acontecer, a prática recomendada é encerrar a sessão de incorporação do Looker. É possível encerrar a sessão de incorporação do Looker destruindo o iframe de incorporação ou definindo o valor de session_reference_token_ttl como zero na mensagem session:tokens. Se você definir o valor de session_reference_token_ttl como zero, o iframe do Looker vai mostrar uma caixa de diálogo de sessão expirada.
Uma resposta 400 não é retornada quando a sessão de incorporação expira. Se a sessão de incorporação expirar, uma resposta 200 será retornada com o valor session_reference_token_ttl definido como zero.
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
}
Considerações de implementação
O aplicativo de incorporação deve monitorar o token de referência da sessão e mantê-lo seguro. Esse token deve ser associado ao usuário incorporado do aplicativo. O token do aplicativo de incorporação pode ser armazenado de uma das seguintes maneiras:
- Na sessão do usuário do aplicativo incorporado
- Em um cache do lado do servidor disponível em um ambiente em cluster
- Em uma tabela de banco de dados associada ao usuário
Se a sessão estiver armazenada como um cookie, ele precisará ser criptografado. O exemplo no repositório do SDK incorporado usa um cookie de sessão para armazenar o token de referência de sessão.
Quando a sessão de incorporação do Looker expirar, uma caixa de diálogo vai aparecer no iframe incorporado. Neste ponto, o usuário não vai poder fazer nada na instância incorporada. Quando isso ocorre, eventos session:status são gerados, permitindo que o aplicativo de incorporação detecte o estado atual do aplicativo Looker incorporado e realize alguma ação.
Um aplicativo de incorporação pode detectar se a sessão de incorporação expirou, verificando se o valor session_reference_token_ttl retornado pelo endpoint generate_tokens é zero. Se o valor for zero, a sessão de incorporação expirou. Considere usar uma função de callback para gerar tokens quando a incorporação sem cookies estiver sendo inicializada. Assim, a função de callback pode determinar se a sessão de incorporação expirou e vai destruir o iframe incorporado como alternativa ao uso da caixa de diálogo padrão de sessão incorporada expirada.
Como executar o exemplo de incorporação sem cookies do Looker
O repositório do SDK de incorporação contém um cliente e um servidor expresso de nós simples escritos em TypeScript que implementa um aplicativo de incorporação simples. Os exemplos mostrados anteriormente foram retirados dessa implementação. O exemplo a seguir pressupõe que sua instância do Looker foi configurada para usar a incorporação sem cookies, conforme descrito anteriormente.
É possível executar o servidor da seguinte maneira:
- Clone o repositório do SDK de incorporação:
git clone git@github.com:looker-open-source/embed-sdk.git - Altere o diretório:
cd embed-sdk - Instalar as dependências:
npm install - Configure o servidor, conforme mostrado na seção Configurar o servidor deste documento.
- Execute o servidor:
npm run server
Configurar o servidor
Crie um arquivo .env na raiz do repositório clonado. Ele está incluído em .gitignore.
O formato é o seguinte:
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