Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Pentaho é um software de código aberto para inteligência empresarial, desenvolvido em Java. A solução cobre as tarefas de ETL (Extraction, Transformation and Load), reporting, OLAP e mineração de dados (data-mining). Desenvolvido desde 2004 pela Pentaho Corporation o software foi considerado uma das melhores aplicações para inteligência empresarial em 2008 pela InfoWorld.
Realiza análises de big data, trabalha nativamente com bancos de dados NoSQL e Hadoop, além de poder processar dados de forma distribuída nativamente em cluster, pode rodar sobre o Hadoop em cluster alcançando velocidades extremamente rápidas.
Página | Descrição |
---|---|
Vídeo explicando as principais funcionalidades implementadas no EID-PDI, bem como a organização de seus jobs e transformações.
Vídeo explicando a configuração dos parâmetros de execução dos jobs de atualização do EID-PDI.
Página com o detalhamento do modelo de dados utilizado no EID, incluindo a área de staging, dados, estatísticas e logs.
Descreve os objetivos e as características dos Jobs e Transformações implementadas no EID-PDI.
Instruções para o preenchimento dos parâmetros dos Jobs utilizados no EID-PDI
Vídeo explicando as principais funcionalidades implementadas no EID-PDI, bem como a organização de seus jobs e transformações.
Descreve os objetivos e as características dos Jobs e Transformações implementadas no EID-PDI.
Limpa a base EID ( tabelas do EID e tabelas de Stage)
Importa todos os registros da base de origem validando os CPFs e emails inválidos, carrega vínculos, emails e contas.
Exporta todos estes dados para o LDAP, comparando o que já existe para remover usuários que tenham sido desativados.
Caso apenas um vinculo do usuário seja desativado e a pessoa continue ativa, este vinculo não é apagado do LDAP, apenas do EID.
Usuários encontrados com CPFs duplicados são unificados sempre preservando o registro mais recente e/ou a base mais confiável (base com baseOrigem=1) e evidenciando a unificação no relatório de "Pessoas Duplicadas".
Contas duplicadas são unificadas escolhendo de acordo com o parâmetro configurado e/ou de acordo com o critério da base mais confiável. A unificação é evidenciada no relatório de "Contas duplicadas".
full-job-atualizacao-diaria-truncate
Faz exatamente as mesmas cargas que o full-jobs-atualizacao=diaria, porém antes de inserir os dados no LDAP, ele faz um truncate em toda a base LDAP para só então inserir os dados na base.
Lembrando que por apagar todos os usuários da base LDAP, este job deixa o serviço indisponível enquanto faz a nova carga dos usuários na base.
Por isso recomenda-se que este Job seja executado em horários que o uso dos serviços seja mínimo, por exemplo durante a madrugada.
Um job mais leve e rápido para ser executado com pouco intervalo de tempo, por exemplo de hora em hora.
Este Job faz a carga apenas de Identificação e Conta. Para garantir que novos alunos, ou pessoas que trocaram a senha tenham esta mudança refletida no diretório LDAP rapidamente.
Limpa todas as tabelas de logs existentes na base EID.
Este Job pode ser executado para liberar armazenamento e melhorar o desempenho do Servidor Pentaho.
Limpa todas as tabelas da Base EID exceto os logs.
Pode ser executado quando se deseja zerar toda as exportações realizadas.
Limpa todas as tabelas de estatísticas do EID.
O atributo eppn é gerado a partir do atributo "uid" do usuário.
É gerado um hash do atributo uid e concatenado com o domínio da instituição. O formato sempre é escopado. Ex: xxx@rnp.br
O backup pode ser feito de toda a VM fazendo snapshots regulares e também é possível fazer o backup apenas de todas as transformações/ jobs e relatórios do servidor.
Acessar a interface de cliente do PDI Http://IP_SERVIDOR:8080
Logar com usuario e senha mesmos utilizados no login no cliente.
Acessar Browse Files/ Eid/Cafe/Visualização/Dashboards.
O PDI sempre irá apagar da base LDAP usuários que não estão mais nas Views criadas.
Desta forma se o usuário desativado for removido da View ele será removido da base LDAP na próxima execução do PDI.
Os vínculos depois de inseridos na base LDAP não são removidos.
O que pode ser feito é informar a data de fim do vinculo no atributo "brExitDate" ou remover todo o usuário caso ele não tenha mais nenhum vinculo ativo.
Os usuários são todos exportados para o metadiretório e depois os dados são cruzados analisando quem possui mesmo CPF estes são unificados e exibidos no relatório.
Apenas um registro com os dados daquele cpf é enviado para a base LDAP. Quando existem mais de uma base de dados a prioridade é enviar para o LDAP o registro que vem da base 1. Que deve ser a base com maior credibilidade.
Da mesma forma que com uma base, mas a prioridade para envio ao LDAP será do registro mais recente, considerado mais atualizado e por isso é o registro enviado para o LDAP.
As pessoas serão agrupadas e o registro mais recente será o enviado para a base LDAP. Os demais registros serão descartados e exibidos no relatório de pessoas duplicadas.
Apenas uma conta pode ser enviada para a base LDAP. Quando um usuário possui mais de uma conta o sistema irá escolher entre uma delas para ser enviada a base LDAP, e as demais serão descartadas e exibidas no relatório de pessoas com contas duplicadas. É possível definir via parâmetro do sistema qual conta é enviarda para a base LDAP, a conta mais recente ou a conta mais antiga. Está análise é feita a partir do ID da conta.
Os registros de pessoas que possuem CPFs inválidos são separados em uma lista de erros para serem exibidos para os usuários e não são exportados para a base LDAP até que o CPF esteja correto.
Os registros de email que são inválidos são separados em uma lista de erros para serem exibidos para os usuários e não são exportados para a base LDAP até que o email esteja correto.
Existe um Job específico que limpa todas as tabelas da base EID.
Através da configuração de parâmetros do job principal: full-job-atualizacao-diaria.
Parâmetro converter para base64.
Na configuração de parâmetros do job principal: full-job-atualizacao-diaria.
Acessar Browse Files/ Eid/Cafe/Visualização/Dashboards.
No momento de executar o job no PDI Cliente selecionar Executar no servidor na caixinha de execução.
Existe um Job específico que limpa todas as tabelas de log da base EID.
Na interface WEB do servidor Pentaho acessar o menu Administração/Users.
Verificar nos logs as linhas vermelhas: Elas mostram a causa do erro;
Verificar as conexões se estão todas corretas;
Verificar as Views se contém os dados e se os previews funcionam em todas.
Importação do template de uma máquina virtual pré-configurada para ser o servidor do Pentaho Data Integration (PDI) 9.0.
Este será o aplicativo responsável pela importação dos dados das bases acadêmicas da instituição e exportação para a base LDAP que será utilizada na autenticação dos serviços da Federação CAFe.
Possuir um hypervisor que irá hospedar o host;
Um endereço IP válido na internet;
Os requisitos mínimos de hardware informados pelo fornecedor da Suite Pentaho 8.0 são os seguintes:
Processador: Intel EM64T ou AMD64 Dual-core
Memória RAM: 10 GB, com 6 GB dedicados ao Pentaho Server 8.0
Espaço em disco: 20 GB livres após a instalação.
Todavia, recomendamos como configuração ideal:
Processador: para viabilizar o processamento paralelo, recomendamos utilizar processadores com pelo menos 4 núcleos.
Memória RAM: 20 GB, com 10 GB dedicados ao Pentaho Server 9.0
Espaço em disco: 50 GB livres após a instalação.
Sistema Operacional Ubuntu 18.04 LTS com instalação otimizada para ambientes de virtualização;
Arquitetura de 64 bits;
Obs: Apesar da VM possuir essa configuração, a instituição pode adequar de acordo com a disponibilidade de recurso, respeitando os pré-requisitos.
Importe o arquivo transferido para seu Hypervisor.
Ligue o servidor virtual recém importado, segue as informações de Login na VM:
4. Realizar as configurações de rede da VM.
5. Start no servidor Pentaho:
O serviço do Pentaho é inicializado automaticamente pelo sistema operacional. Todavia, pode-se utilizar os comandos abaixo para intervenções manuais, inicializando e parando, respectivamente:
ATENÇAO:
Certifique-se que na pasta /opt/pentaho-server/tomcat/lib/ não exista mais de uma versão do driver Mysql.
Se existir outro driver mysql em outra versão, como por exemplo, o mysql-connector-java-5.1.17-bin.jar ele deve ser apagado.
A versão correta do driver mysql que deve ficar na pasta é mysql-connector-java-5.1.45-bin.jar.
7. Verificar se o serviço do Mysql está rodando na VM:
9. Verificar se o login ocorreu com sucesso.
Página com o detalhamento do modelo de dados utilizado no EID, incluindo a área de staging, dados, estatísticas e logs.
O EID PDI realiza a integração do cadastro de usuários das instituições que fazem parte da CAFe por meio da leitura de suas bases de dados e posterior sincronização com o servidor LDAP da comunidade.
A configuração padrão desse serviço realizar a integração das seguintes entidades:
Identificação
Conta
Aluno
Professor
Técnico
Para cada entidade listada acima, a instituição precisa disponibilizar uma VIEW no seu banco de dados com as seguintes características:
OBS. : Caso a sua instituição não deseje importar para a base LDAP os dados de alguma das Views como por exemplo Professor, a estrutura da View deve ser criada mesmo assim e deverá ficará vazia sem nenhum dado.
01. IDENTIFICAÇÂO
Nome da view: Pessoas
Atributo | Descrição | Valor Padrão | Obrigarótio | Tipo |
---|---|---|---|---|
Todos os campos acima precisam existir na view. Caso a instituição não deseje informar os campos não obrigatórios, ainda assim deve criá-lo na view, com o seu conteúdo como definido na coluna "Valor Padrão"
02. CONTA
Nome da view: Conta
Todos os campos acima precisam existir na view. Caso a instituição não deseje informar os campos não obrigatórios, ainda assim deve criá-lo na view, com o seu conteúdo como definido na coluna "Valor Padrão".
03. EMAIL
Nome da view: Email
Todos os campos acima precisam existir na view. Caso a instituição não deseje informar os campos não obrigatórios, ainda assim deve criá-lo na view, com o seu conteúdo como definido na coluna "Valor Padrão".
04. ALUNO
Nome da view: Aluno
Todos os campos acima precisam existir na view. Caso a instituição não deseje informar os campos não obrigatórios, ainda assim deve criá-lo na view, com o seu conteúdo como definido na coluna "Valor Padrão".
05. PROFESSOR
Nome da view: Professor
Todos os campos acima precisam existir na view. Caso a instituição não deseje informar os campos não obrigatórios, ainda assim deve criá-lo na view, com o seu conteúdo como definido na coluna "Valor Padrão".
06. TÉCNICO
Nome da view: Tecnico
Todos os campos acima precisam existir na view. Caso a instituição não deseje informar os campos não obrigatórios, ainda assim deve criá-lo na view, com o seu conteúdo como definido na coluna "Valor Padrão".
Apenas para instituições que não utilizarão a VM
Esse roteiro apresenta o conjunto de ações necessárias para a configuração de um servidor Linux Ubuntu, 18.04 LTS, com os aplicativos necessários para o funcionamento do EID-PDI.
Os requisitos mínimos de hardware informados pelo fornecedor da Suite Pentaho 9.0 são os seguintes:
Processador: Intel EM64T ou AMD64 Dual-core
Memória RAM: 10 GB, com 8 GB dedicados ao Pentaho Server 8.0
Espaço em disco: 20 GB livres após a instalação.
Todavia, recomendamos como configuração ideal:
Processador: Para viabilizar processamento paralelo, recomendamos utilizar processadores com pelo menos 4 núcleos.
Memória RAM: 20 GB, com 10 GB dedicados ao Pentaho Server 9.0
Espaço em disco: 50 GB livres após a instalação.
3.1. Atualização do sistema operacional.
3.2. Instalação da máquina virtual Java - JDK (1.8).
3.3. Instalação do unzip.
3.4 Instalação do Pentaho 9.0
3.5 Copiar o driver JDBC do MySQL para os diretórios do Pentaho (* incluir os driver dos SGBDS: SQL Server, Oracle, Postgres)
ATENÇAO:
Certifique-se que na pasta /opt/pentaho-server/tomcat/lib/ não exista mais de uma versão do driver Mysql.
Se existir outro driver mysql em outra versão, como por exemplo, o mysql-connector-java-5.1.17-bin.jar ele deve ser apagado.
A versão correta do driver mysql que deve ficar na pasta é mysql-connector-java-5.1.45-bin.jar.
Ao atualizar o pentaho ou o driver é necessário testar se o driver novo é compatível com a versão. O Driver mysql-connector-java-5.1.17-bin.jar dá erro na execução dos jobs.
3.6. Instalação do plugin Saiku Analytics
3.7 Iniciar o serviço do Pentaho BI Server
3.8 Instalação do Pentaho Data Integration
3.9 Configuração do Servidor Pentaho BI Server
Acesse a o Pentaho BI Server, por meio de um browser, na URL http://localhost:8080, utilizando o usuário Admin e a senha password.
O primeiro passo será a criação do usuário e o perfil EID, conforme os passos abaixo:
Criar usuário EID:
a) Clicar no menu superior à esquerda: (Home v).
b) Selecionar opção Administration
c) Selecionar opção Manage Roles
d) Selecionar New role (+)
e) Digitar o nome EID e clicar em OK.
f) Marcar as permissões:
Schedule Content
Read Content
Publish Content
Create Content
Execute
Manage Data Sources
g) Selecionar a aba Manage Users:
h) Mantenha a tecla CTRL pressionada e selecione os usuários abaixo:
pat
suzy
tiffany
i) Preencher os dados do usuário EID, com a respectiva senha (na VM padrão: eidpdi) , e clicar em OK.
j) Selecione o usuário EID:
k) Selecione a Role EID e clique na sinal > :
l) Alterar a senha do usuário ADMIN, selecionando o usuário e clicando em EDIT Password.
m) Digite a nova senha no campo New Password. Repita a senha no campo Confirm Password. Digite a senha atual (cujo padrão é: password) no campo Administrator Password e clique em OK.
3.10 Acessar o PDI - Pentaho Data Integration
3.11 - Verificar se a conexão das bases com os dataSources no PDI estão configuradas corretamente tendo acesso a base Local Mysql, na interface Web do PDI.
3.12 Configurar o acesso ao repositório
a) Clique no menu superior à direita (Connect v) e selecione Repository Manager
b) Selecione ADD > Get Started e preencha:
Display Name: EID - Repositório CAFe
Selecione FINISH.
c) Clique no menu superior à direita (Connect v) e selecione EID - Repositório CAFe e digite o usuário EID e a respectiva senha. Clique em connect.
3.13 Importar transformações/Jobs/Relatórios EID-PDI para o Servidor Pentaho:
a) Acesse a VM Pentaho Server e via linha de comando baixe o arquivo abaixo e salve na pasta /opt/eid:
b) Execute o seguinte comando para importar as transformações e Jobs para o servidor Pentaho:
Acesse o cliente PDI e verifique se todos os Jobs, transformações e relatórios foram importados com sucesso.
É possível também fazer a importação das transformações via interface gráfica no Cliente PDI:
1) Clique na barra de menu TOOLS > Repositório > Import Repository
Selecione o arquivo que contém as ETLS e Jobs e clique em OK.
Na janela de confirmação para criação de regras, clique em Não.
selecione a pasta / e clique em ok.
Fazer backup das transformações/Jobs/Relatorios do PDI:
a) Acesse a VM Pentaho Server e via linha de comando execute:
O arquivo de backup será gerado em: /opt/eid/backup_eid_full.zip
Vídeo explicando a configuração dos parâmetros de execução dos jobs de atualização do EID-PDI.
O PDI (Pentaho Data Integration) pode rastrear versões e comentários de trabalhos, transformações e informações de conexão quando você os salvar.
Você pode ativar ou desativar o controle de versão e o rastreamento de comentários modificando suas instruções relacionadas no arquivo de texto repository.spring.properties.
Por padrão, o controle de versão e o rastreamento de comentários estão desativados (definido como falso).
Para ativar o de controle de versão do PDI:
1- Saia e feche do cliente PDI (também chamado de Spoon).
2- Pare o servidor Pentaho:
3- Abra o arquivo pentaho-server/pentaho-solution/system / repository.spring.properties. Para habilitar o controle de versão
edite a instrução versioningEnabled e defina-a como true.
versioningEnabled = true
Caso deseje também habilitar a opção de inserir comentários a cada arquivo modificado altere também a propriedade versionCommentsEnabled = true
versionCommentsEnabled = true
Se você deseja controle de versão, mas não rastreamento de comentários:
Edite a instrução versioningEnabled e defina-a como true.
Edite a instrução versionCommentsEnabled e defina-a como false.
versioningEnabled = true
versionCommentsEnabled = false
Salve e feche o arquivo.
Se você desativar o controle de versão, o rastreamento de comentários também será desativado.
4- Inicie o servidor Pentaho:
cd /opt/pentaho-server
./start-pentaho.sh
Verificando a opção de controle de versão ativada no PDI:
Inicie o PDI Client (também chamado de Spoon).
Verifique se o controle de versão está definido como pretendido.
Conecte-se ao Repositório Pentaho
No PDI Client, clique em Tools > Repository > Explore
Na janela Repository Explorer, clique na guia Browse e clique no nome de um arquivo:
Verifique se o controle de versão está ativado ou desativado:
Ativado - Você pode ver a guia Controle de acesso e a guia Histórico da versão está visível.
Desativado - Você pode ver a guia Controle de acesso, mas a guia Histórico de versões está oculta.
Verifique se o rastreamento de comentários está ativado ou desativado:
Ativado - a guia Histórico da versão é exibida com o campo Comentários. Quando você salva uma transformação, job ou informações de conexão, uma caixa para inserir um comentário é exibida.
Desativado - a guia Histórico da versão é exibida e o campo Comentário está oculto. Quando você salva informações de transformação, job ou conexão, não é mais necessário inserir um comentário. O controle de versão está ativo, mas sem exibir comentários.
Criado no formato OVF ()
Baixe o arquivo da VM:
6. Disponibilizar o Driver para conexão com a base Mysql (utilizado pela base intermediária) Baixar aqui Driver Mysql: () Baixar também o Driver do banco que a instituição utiliza nas bases acadêmicas (Oracle, SQLServer ou Postgresql). Copiar os dois drivers (Mysql e o Driver usado pela base da instituição) para as seguintes pastas na VM do Servidor:
8. Acessar via navegador o Pentaho que está instalado na VM do passo anterior, através da seguinte URL:
=> Template VM versão 8
Atributo | Descrição | Valor Padrão | Obrigatório | Tipo |
---|---|---|---|---|
Atributo | Descrição | Valor Padrão | Obrigatório | Tipo |
---|---|---|---|---|
Atributo | Descrição | Valor Padrão | Obrigatório | Tipo |
---|---|---|---|---|
Atributo | Descrição | Valor Padrão | Obrigatório | Tipo |
---|---|---|---|---|
Atributo | Descrição | Valor Padrão | Obrigatório | Tipo |
---|---|---|---|---|
i) Clique em excluir e confirme:
h) Clique em adicionar usuário :
URL:
"" => cliente versao 8
"" => pentaho-server-ce-8.0.0.0-28.zip
Id
É a chave primária no cadastro de pessoas da instituição.
-
x
String
Nome
Nome completo da pessoa.
-
x
String
Sexo
Sexo da pessoa. Informar F ou M.
String vazia
String
Nascimento
Data de nascimento da pessoa.
-
x
YYYY-MM-DD
Documento
Número do documento de identificação da pessoa.
String vazia
String
NomePai
Nome completo do pai da pessoa.
String vazia
String
NomeMae
Nome completo da mãe da pessoa.
String vazia
String
cpf
Número do cpf da pessoa, sem máscara, com o dígito. Ex.: 01234567890
-
x
String
Id
É a chave primária no cadastro de contas da instituição.
-
x
String
Login
Login atribuído à conta.
-
x
String
Senha
Senha da conta, em formato hexadecimal.
-
x
String
AlgoritmoSenha
Algoritmo utilizado para encriptar a senha. Exemplo: SHA, MD5, CRYPT, etc...
Nulo apenas para senha em texto plano
x
String
IDPessoa
É a chave estrangeira referente à pessoa portadora dessa conta. Deve ser validada no cadastro de Pessoas
-
x
String
sambaNTPassword
É a senha no formato MSCHAPV2 para dispositivos IOS e Windows conseguirem acessar o Eduroam
Nulo
String
sambaSID
Identificador único obrigatório para o esquema Samba.
Nulo
String
Id
É a chave primária no cadastro de contas da instituição.
-
x
String
Email válido para uma pessoa
-
x
String
IDPessoa
É a chave estrangeira referente à pessoa portadora dessa conta. Deve ser validada no cadastro de Pessoas
-
x
String
Id
É a chave primária no cadastro de contas da instituição.
-
x
String
Nome_Curso
Descrição do curso do aluno.
-
x
String
CodInepCapes_Curso
Código do curso do aluno no Inep.
String Vazia
String
Nivel_Curso
Descrição do nível do curso do aluno. Ex.: Graduação, Mestrado, Etc.
String Vazia
String
dataInicioVinculo
Data do início do vínculo com o curso.
-
x
YYYY-MM-DD
dataFimVinculo
Data do fim do vínculo com o curso
Nulo
YYYY-MM-DD
IDPessoa
É a chave estrangeira referente à pessoa portadora dessa conta. Deve ser validada no cadastro de Pessoas.
-
x
String
Id
É a chave primária no cadastro de contas da instituição.
-
x
String
siape
Matrícula do servidor no siape.
Nulo
String
nível
Nível do professor.
String vazia
String
titulacao
Titulação do professor.
String vazia
String
dataInicioVinculo
Data do início do vínculo como Professor
-
x
YYYY-MM-DD
dataFimVinculo
Data do fim do vínculo como Professor, caso o vínculo já tenha se encerrado
Nulo
YYYY-MM-DD
IDPessoa
É a chave estrangeira referente à pessoa portadora dessa conta. Deve ser validada no cadastro de Pessoas.
-
x
String
Id
É a chave primária no cadastro de contas da instituição.
-
x
String
siape
Matrícula do servidor no siape.
Nulo
String
nivelCapacitacao
Nível de capacitacao do técnico.
String vazia
String
funcaoPrincipal
Função principal do técnico.
String vazia
String
dataInicioVinculo
Data do início do vínculo como Técnico
-
x
YYYY-MM-DD
dataFimVinculo
Data do fim do vínculo como técnico, caso o vínculo já tenha se encerrado.
Nulo
YYYY-MM-DD
IDPessoa
É a chave estrangeira referente à pessoa portadora dessa conta. Deve ser validada no cadastro de Pessoas.
-
x
String
Este documento apresenta o procedimento necessário para solicitar a inclusão do bloco de metadados de um Provedor de Identidade (Shibboleth IdP) na Federação Chimarrão.
Durante a instalação do Shibboleth IdP é gerado um arquivo que contêm o bloco de metadados do provedor. Para que um provedor faça parte de uma Federação, uma das providências necessárias é a inclusão do bloco de metadados do provedor no arquivo de metadados da federação. Os metadados da federação servem para informar aos seus participantes quais são os servidores "reconhecidos" e confiáveis.
O arquivo que possui o bloco de metadados do seu Provedor de Identidade é o /opt/shibboleth-idp/metadata/idp-metadata.xml
Envie o arquivo de metadados para o endereço atendimento@rnp.br (caso já tenha um processo em andamento, basta mandar em reposta ao e-mail da equipe).
A equipe de operação CAFe então fará a verificação da integridade desse metadado, tudo estando certo esse metadado será inserido na federação Chimarrão para que seja iniciado a homologação do IDP.
Estes procedimentos devem ser executados em uma máquina diferente do servidor Pentaho, necessário uma máquina com interface gráfica, pode ser a máquina local do usuário.
Instalar Java JDK versão 8
Baixar o PDI( https://svn.cafe.rnp.br//arquivos/pdi-ce-9.0.0.0-423.zip )
Descompactar no diretório de preferência.
Setar variável JAVA_HOME e PENTAHO_JAVA_HOME com caminhos do JAVA JDK
Copiar o driver do Mysql disponível em https://svn.cafe.rnp.br/repos/CAFe/conf/shibboleth-idp/shib-v3/pdi-pentaho/mysql-connector-java-5.1.45-bin.jar para a seguinte pasta no cliente: pentaho/biclient/data-integration/lib
Baixar o driver correspondente a base de dados utilizada pela sua instituição (SQL Server, Oracle, Postgresql, etc) e disponibilizar na seguinte pasta no cliente PDI: pentaho/biclient/data-integration/lib
Executar o arquivo spoon.bat para iniciar o cliente PDI.
Instalar Java JDK 8:
2. Configuração da JAVA_HOME:
3. Criar diretório:
4. Baixar PDI e descompactar:
5. Copiar Driver Mysql para o cliente:
Baixar também o driver correspondente a base de dados utilizada pela sua instituição (SQL Server, Oracle, Postgresql, etc) e disponibilizar na seguinte pasta no cliente PDI: /opt/pentaho/biclient/data-integration/lib
6. inicializar o cliente PDI:
PDI - Pentaho Data Integration - Configuração da conexão com Pentaho BI Server
Clique em Connect (canto superior direito)
Clique em repository manager
Clique em ADD:
Clique Get Started:
Preencha
Display Name: EID-PDI Server
FINISH
Clique em Connect Now
Digite usuário, senha e clique em connect:
User: admin
Senha: password
Versão 8 PDI Cliente: https://svn.cafe.rnp.br/repos/CAFe/conf/shibboleth-idp/shib-v3/pdi-pentaho/pdi-ce-8.0.0.0-28.zip
Página destinada para orientar os clientes da CAFe com a instalação do IDP versão 4
Com a finalidade de facilitar e tornar mais ágil a instalação de Provedores de Identidade (IdP) na Federação CAFe, a RNP disponibiliza a vm-idp que é uma pre-instalação de um IdP em forma de máquina virtual.
Este tutorial apresenta a sequência de passos necessários para que o usuário faça a configuração inicial da vm-idp.
Informações de acesso à máquina virtual:
usuário: cafe
senha: 0p9o*I&U6y5t
IMPORTANTE
Máquina para IDP deve ter IP válido, pode se usar NAT desde que esse esteja corretamente apontado para um endereço público.
DNS direto e reverso devem estar configurados (sug: shibboleth.[inst].edu.br)
O nome do seu host IDP ficará visível para todos durante o acesso ao IDP, escolha o nome com cuidado. Após escolher um nome e realizar todo o procedimento ficará mais complicado alterar o nome do seu host posteriormente.
Firewall: Liberar no firewall da instituição e do servidor IDP a comunicação entre o servidor IDP e o host da RNP conforme abaixo:
Portas 80 e 443 <TCP> liberadas no firewall local (IdP) e no instituicional para o mundo.
Estatísticas: Origem: (Host-RNP - 200.133.59.169) - Destino: (Servidor IDP) - Porta: TCP 5044
No primeiro boot da vm-idp será carregado um script que é responsável por fazer a configuração do IdP. Tal script fará uma sequência de questões que deverão ser respondidas corretamente pelo usuário. O script irá iniciar assim que você alterar para o usuário root.
Mude o usuário atual para um usuário root:
password: 0p9o*I&U6y5t
Caso queria cancelar a execução do script use o comando:
ctrl+c
Escolha "s"
1. A cada pergunta realizada pelo script será solicitada uma confirmação de resposta. Pressione "s" para confirmar a resposta e "n" para corrigir o valor digitado.
2. O script de instalação pode ser finalizado a qualquer momento pressionando-se as teclas CTRL+C. Caso isto seja feito, as configurações feitas até tal momento serão descartadas e a vm-idp executará o script novamente na inicialização seguinte.
A seguir serão apresentadas as questões presentes no script e sua devida explicação:
Esta é a primeira tela exibida após a inicialização da máquina virtual. Pressione "Enter" para prosseguir com a configuração.
Uma simulação de respostas às questões acima é apresentada nas linhas abaixo.
Digite o endereco IP: 123.123.123.123
Digite a mascara: 24
Digite o gateway: 123.123.123.1
Digite o IP do DNS: 123.200.113.11
Após inserir o primeiro servidor DNS o script irá perguntar que gostaria de configurar um segundo servidor DNS, digite "1" para prosseguir com a configuração do segundo DNS ou apenas "2" para deixar somente um servidor DNS configurado.
Após realizar o termino da configuração inicial, hostname e IP o script irá iniciar as etapas seguintes, que precisam de acesso a internet para continuar. Se tudo der certo você verá a seguinte saída:
Agora que o script possui acesso a rede ele irá iniciar a tarefa de atualização do sistema operacional. Fará de forma automática e executará um apt update + apt upgrade, apenas aguarde.
Nesse momento o script irá acessar o repositório da CAFe para baixar o script que fará a segunda etapa de configuração do IDP.
7. Configuração do acesso e comunicação com diretório (AD / LDAP)
Aonde é perguntado o domínio do seu AD ou LDAP inserir o seu domínio local.
Endereço do servidor digitar o nome ou ip do seu diretório.
Digitar porta, inserir porta de comunicação com seu diretório, normalmente 389 e 636.
Dizer para o script se o seu diretório usa SSL ou não.
9. O bloco seguinte se refere às definições da base de usuários da instituição:
Digitar o Base DN aonde deve ocorrer a consulta do Shibboleth para validar os seus usuários.
Digitar o DN da conta que fará a consulta no Base DN inserido acima.
DIgitar a senha da conta informada acima.
10. Preencha as informações referentes aos responsáveis pelo serviço na instituição:
HAVERÁ UM MOMENTO EM QUE SERÁ PERGUNTADO PELA SIGLA DE SEU ESTADO, DIGITE NO FORMATO "BR", Ex: RJ, ES, RS, PE, AM, etc...
ESSE PONTO É IMPORTANTE PARA A CORRETA CONFIGURAÇÃO DO MONITORAMENTO.
11. Após o preenchimento das configurações acima, o sistema irá proceder com a configuração automática do IDP. Esta configuração pode levar alguns minutos.
12. Por fim é solicitada a criação de uma nova senha para o usuário cafe. Lembre-se que é importante a criação de um senha complexa para garantir a segurança de seu servidor:
Também será solciitado uma senha para o usuário root.
13. Após confirmação da senha de root, o sistema será reiniciado
14. Visualização de logs:
Caso você deseje visualizar os logs gerados pela Shibboleth é possível utilizar o seguinte comando (já possui um filtro para mostrar apenas mensagens com WARN ou ERROR):
DICA
1. Para garantir que os passos descritos acima foram corretamente seguidos é necessário a execução de um script de homologação. Para fazer download desde script utilize a linha de comando abaixo:
2. Após fazer download, execute este script com permissão de root.
OK - Nao foram encontrados pontos impeditivos para o processo de adesao.
Envie o arquivo de log gerado (XYZ.log) para o Service
Desk da RNP para dar continuidade ao atendimento.
ERRO - Foram encontrados pontos impeditivos para o processo de adesao.
Verifique e corrija os erros e então execute novamente este script.
Ao acessar o Client Web do Pentatho, a tela acima será exibida, solicitando login e senha.
Efetuado o login, entraremos na página inicial da aplicação, onde teremos algumas opções de gerenciamento.
Vá em Home > Administration
Dentro desta sessão, teremos o gerenciamento dos Usuários (criação), Roles e perfis do Pentaho Server, conforme imagem abaixo:
Gerenciamento de Roles:
Configuração do SMTP para envio de e-mail:
Configuração relacionada a remoção de arquivos antigos, como os logs gerados após so agendamentos nas execuções dos Jobs:
-Log de execução de Jobs e Transformações:
Todo processo executado no PDI terá informações de saída relacionadas ao log do fluxo de trabalho. Isso fornece detalhes sobre o que está acontecendo durante a execução. Os logs podem ser monitorados através do cliente PDI ou da interface online do PDI via navegador: IP_SERVIDOR:8080
Aqui está uma lista de itens com os quais o log pode ajudar:
• Fornece informações relevantes sempre que uma execução do processo apresenta um erro, como etapas que estão falhando e rastreiam com a descrição principal do erro
• Fornece informações sobre um fluxo de trabalho se houver divisão de decisão
• Detecta gargalos e etapas de desempenho abaixo do padrão com base na duração de um procedimento; por exemplo, os tempos de execução armazenados podem ser usados para detectar se um processo está demorando mais do que habitual
• Mostra o status dos processos atualmente em execução. Os logs fornecem informações sobre quando o processo iniciado, onde está atualmente, e dados relacionados ao seu status.
• Rastreia o que foi feito e quando.
Durante a execução dos jobs e transformações no PDI Cliente conseguimos verificar o log de execução da ferramenta.
Neste log conseguimos visualizar os detalhes sobre a execução como tempo restante, número de registros, erros de conexão com as bases de origem ou destino, erros na transformação de dados, excessões, etc
Para acessar este log basta clicar no ícone de engrenagem disponível logo abaixo a tela de exibição do Job:
Existem 7 configurações possíveis para o detalhamento de logs no Spoon:
Nothing - O log está ativado, mas não registra nenhuma saída.
Error - Mostra apenas linhas de erro.
Minimal - Usa apenas o log mínimo. Fornece informações sobre o status dos fluxos de trabalho.
Basic- Recomendação: Use o nível de log Básico (padrão). Ele mostra informações relacionadas a cada etapa.
Detailed - Use isto para solução de problemas: fornece uma saída detalhada de login.
Debug- Uma saída detalhada para fins de depuração. O nível de log de depuração nunca deve ser usado em um ambiente de produção.
Row Level (Very Detailed) - Registrando em um detalhe no nível da linha. Isso gera uma enorme quantidade de dados de saída de log.
Recomendamos usar o log Basic que registra basicamente as informações mais importantes da execução do Job.
Já quando existem erros no processo o tipo Error pode ser útil para identificar o problema rapidamente, e o tipo Row Level para identificar a linha que gerou o erro.
- Log Tomcat e PDI Server
O PDI Server roda no servidor de aplicação Tomcat. O Tomcat possui logs próprios, desta forma quanto o PDI não está disponível o primeiro log que devemos verificar é o do Tomcat.
/opt/pentaho-server/tomcat/logs
Logs disponíveis:
Catalina.out - Loga a maioria dos erros que acontecem na administração da ferramenta WEB
localhost.log -
localhost_access_log.2020-07-31.txt - Logs de acesso
host-manager.2018-08-07.log
manager.data.log
pentaho.log - O log próprio do PDI Server (pentaho.log) também disponível na pasta pode ser consultado para verificar problemas na ferramenta.
- Log do cliente Spoon:
O Spoon (cliente utilizado para acessar o PDI Server) também possui um log onde é possível verificar problemas que impedem a ferramenta de funcionar. Este log fica localizado em: /opt/dataintegration/logs/spoon.log
-Práticas recomendadas para níveis de log:
Os níveis de log devem ser mais baixos em um ambiente de produção ou controle de qualidade, mas podem ser mais altos em um ambiente de desenvolvimento ou não de produção.
O nível de log de depuração nunca deve ser usado em um ambiente de produção.
Os níveis de log também podem ser especificados quando o processo é executado com o PDI Client ou qualquer outra ferramenta de linha de comando.
O desempenho do processo pode ser afetado se o nível de registro de log form muito detalhado. Isso também aumentara a quantidade de informações armazenadas no log.
- Relatório de Erros:
Acesso via IP:8080
Esta página visa auxiliar o cliente no agendamento de jobs do Pentaho Web
O agendamento é efetuado para automatizar a execução de um Job em específico. No exemplo, utilizamos o full-job-atualizacao-diaria.
Segue abaixo o caminho dos Jobs:
Home > eid > cafe (selecionar o job no qual sera feito o agendamento)
Após selecionar o Job, vá na opção Schedule, aparecerá a imagem abaixo:
Marque a opção "Append timestamp to generated content", as opções abaixo irão aparecer:
o diretório /home/admin ficará salvo os logs dos agendamentos
Indo em "Next" será apresentada a tela abaixo:
Nela podemos escolher o tipo de recorrência na execução do Job.
Feita a escolha de agendamento, é só ir em "Next".
Os parâmetros foram definidos durante a configuração do Client Pentaho. O "Finish" encontra-se indisponível pois neste servidor já existe esse Schedule cadastrado, portanto o Pentaho nao permite cadastrar outro, apenas alterar o mesmo Schedule para evitar duplicata.
Para verificar os agendamentos, basta ir no caminho abaixo:
Browser Files > Schedules
Esta opção nos permite gerenciar os agendamentos configurados no servidor Pentaho.
Instruções para o preenchimento dos parâmetros dos Jobs utilizados no EID-PDI
OBS: Estes parâmetros precisam ser configurados nos seguintes jobs:
full-job-atualizacao-diaria
full-job-atualizacaoo-diaria-truncate
job-atualizacao-contas-intradia
Antes de executar estes jobs no PDI é necessário preencher os parâmetros obrigatórios.
Os parâmetros configuráveis nesta tela se dividem em :
Parâmetros para configuração de envio de email com alertas e erros na execução dos Jobs:
indicadorEnvioEmailAtivo - Quando informado com o valor "True" os alertas gerados serão enviados para o email configurado, caso configurado com o valor "False" nenhum email de alertas será enviado. Obrigatório.
AuthenticationPassword - Senha do usuário no servidor SMTP em texto plano.
AuthenticationUser - Usuário de autenticação no servidor SMTP, com endereço completo. Ex.: eidpdi@cafe.rnp.br
destinationAddress - Email que receberá os alertas quando o PDI encontrar erros. Caso queira enviar para mais de um email , informar separados por vírgula. Ex.: alerta.eid@cafe.rnp.br, alerta2@cafe.rnp.br
pentahoAddress - Ip público e porta do servidor pentaho. Ex.: 138.121.71.89:8080 , necessário para enviar o link do relatório de inconsistências encontradas durante o processamento no email de alerta.
senderAddress - Email que enviará as alertas. . Ex.: eidpdi@cafe.rnp.br
serverSMTPPort - Porta do servidor SMTP da Instituição. Ex.: 587
serverSMTPServer - Endereço do servidor SMTP da Instituição. Exemplo: smtp.rnp.br Estes parâmetros informados acima serão obrigatórios apenas se o parâmetro "indicadorEnvioEmailAtivo" for informado com o valor "True".
Parâmetros para conexão com a base LDAP:
host_address_ldap - Incluir o IP ou nome do servidor LDAP. Ex.: 138.121.71.89 ou ldap.rnp.br. (Obrigatório)
host_port_ldap - Incluir a porta do servidor LDAP. Ex.: 389 (Obrigatório)
raiz_base_ldap - Incluir a raiz do LDAP configurada no servidor. Ex.: dc=rnp,dc=br (Obrigatório)
admin_ldap - Usuário configurado na base Ldap com permissão de leitura e escrita na base. Ex: cn=admin,dc=rnp,dc=br (Obrigatório)
senha_admin_ldap - Senha em texto plano do usuário configurado no parâmetro "admin_ldap". (Obrigatório)
dominio_Instituicao - Incluir o domínio da instituição. Ex.: rnp.br, utilizado para gerar atributos escolados como "Eppn" por exemplo. (Obrigatório)
Parâmetro para escolher forma de unificação de Conta:
manterContaMaisRecente - Quando o PDI detecta mais de uma conta cadastrada para o mesmo usuário é necessário escolher apenas uma para ser enviada ao servidor LDAP. Ao preencher este parâmetro com "True" a conta mais recente será enviada ao LDAP, para detectar que a conta é mais recente o PDI verifica o ID do registro importado e compara qual é maior. No caso de mais de uma base de dados é possível também definir a prioridade pela base configurada como mais confiável, que no caso é sempre a primeira a ser importada com o campo "baseOrigem=1" . (Obrigatório)
Parâmetro para converter a senha para base64:
castToB64 - Em algumas situações, o hash SHA e MD5 das senhas é armazenado como uma sequência de caracteres hexadecimais nas bases institucionais. Para envio da senha para o LDAP via LDIF é necessário que esse hash esteja em base64. Ao informar este parâmetro como "True" um algoritmo é usado durante a importação dos dados para transformar o valor hexa em base64, de forma a preservar o hash original da senha no diretório. Caso a senha já esteja no formato base64, ou esteja em texto plano o parâmetro deve ser informado com o valor "false". (Obrigatório) É importante ressaltar que o campo algoritmoSenha, configurado na transformação de "Conta" deve estar preenchido corretamente:
SHA, para senhas com hash SHA
MD5, para senhas com hash MD5
CRYPT, para senhas crypt
vazio, para senhas em texto plano
Esta página visa auxiliar o cliente na localização dos relatórios do Pentaho Web
Os relatórios são usados para gerenciamento da base através do Pentaho, auxiliando na identificação de contas duplicadas, monitoramento de cadastro e agendamento dos Jobs.
O painel de relatório pode ser encontrado no caminho abaixo:
Home > eid > cafe > visualizacao > dashboards
Segue abaixo a imagem ilustrando a localização dos painéis de monitoramento:
Os relatórios a serem abertos são os de ícone azul, os demais são código fonte, e não devem ser abertos.
Para abrir o relatório, selecione-o e vá na opção "Open in a new window", conforme abaixo:
O relatório PainelPessoas.wcdf nos mostram os usuários que foram importados para a nova base, utilizando o Pentaho. Na listagem, é exibida as pessoas e seus vínculos.
Os relatórios são abertos em formas de Pop-Up, que podem acabar sendo bloqueadas pelo navegador.
O relatório a seguir nos mostra os Jobs que foram executados, resultados e se houve erro durante o processo.
Para abrir o relatório, selecione-o e vá na opção "Open in a new window", conforme abaixo:
Podemos verificar o histórico de Jobs executados, os concluídos e abortados. No exemplo abaixo, mostra que tivemos uma ocorrência, indicando que um usuário em específico não foi migrado devido a um erro de formato no e-mail. Neste caso, o e-mail possui um espaço.
O relatório a seguir, exibe as pessoas com o mesmo CPF na base.
Para abrir o relatório, selecione-o e vá na opção "Open in a new window", conforme abaixo:
No exemplo de base abaixo, não temos evidências de cadastros com CPF's duplicados. Mas caso exista na base do cliente, o Pentaho mostrará a lista na tela abaixo.
O relatório a seguir funciona de forma similar ao anterior, porém, o resultado nos trás as contas duplicadas na base.
Para abrir o relatório, selecione-o e vá na opção "Open in a new window", conforme abaixo:
No exemplo abaixo, a base não possui contas duplicadas. Mas caso exista na base do cliente, o Pentaho mostrará a lista na tela abaixo.
As orientações abaixo são destinadas aos responsáveis pela TI da instituição e que desejam fazer parte da CAFe.
Caso seja um usuário verifique a página de .
Para aderir a CAFe a instituição precisa:
Estar credenciada à RNP
Solicitar a adesão ao Service Desk
Em linhas gerais o processo consiste em:
Realizar uma entrevista técnica para apresentação do serviço e sanar dúvidas da instituição
A instituição realizar a instalação do servidor do serviços e quando necessário, a configuração da base de usuários.
O tempo total do processo vai depender da disponibilidade da realização da entrevista e o tempo que a instituição vai levar para instalação.
Apache Directory Studio (ApacheDS) é uma ferramenta gráfica para manipulação de bases LDAP. O ApacheDS possui uma série de funcionalidade como por exemplo manipulação de entradas, atributos, arquivos LDIF, etc. Essa ferramenta é baseada na IDE Eclipse e possui versões para Linux, MacOS e Windows. O download pode ser feito através do seguinte link Neste tutorial básico serão apresentadas algumas das funcionalidades básicas desta ferramenta que serão úteis para o projeto E-AA.
Para que o ApacheDS possa manipular um diretório LDAP deve-se inicialmente configurar o acesso a tal diretório na ferramenta. Para fazer tal configuração deve-se executar o seguinte roteiro:
Estando o ApacheDS em execução, clique em FILE > NEW. Expanda a o item LDAP Browser, selecione a opção LDAP Connection e clique em NEXT . A Figura 1 apresenta a tela descrita.
Tão logo a tela Network Parameter seja exibida informe um nome para esta conexão LDAP (campo Connection name), o endereço IP ou hostname do servidor LDAP (campo Hostname) e utilize os valores padrões para os campos porta (Port: 389) e método de encriptação (Encryption method: no encryption). A Figura 2 apresenta a tela descrita.
Uma vez preenchido os campos, clique sobre o botão Check Network Parameter a fim de verificar se existe conectividade entre o ApacheDS e o servidor LDAP. Se tudo ocorrer de forma adequada, será exibida uma tela conforma ilustrada na Figura 3. Clique sobre OK para fechar a tela e clique em NEXT na tela Network Parameter.
Na tela Authentication deverão ser preenchidos os campos relativos a autenticação no diretório LDAP. O método de autenticação deverá ser o padrão (Authentication Method: Simple Authentication), o Bind DN ou usuário deverá ser o administrador (i.e.: Bind DN or User: cn=admin,dc=cpd,dc=ufrgs,dc=br) já a senha deverá ser a senha do administrador informada durante a instalação do LDAP. A Figura 4 apresenta a tela descrita.
Uma vez preenchido os campos, clique sobre o botão Check Authentication a fim de verificar se existe a autenticação com o LDAP está correta. Se tudo ocorrer de forma adequada, será exibida uma tela conforma ilustrada na Figura 5. Clique sobre OK para fechar a tela e clique em NEXT na tela Au thentication.
Na tela Browser Options utilize os valores padrões e clique sobre NEXT. A Figura 6 apresenta a tela descrita.
Na tela Edit Options utilize os valores padrões e clique sobre FINISH. A Figura 7 apresenta a tela descrita.
Após seguir os passos anteriores a conexão ao Diretório LDAP estará configurada e será exibida uma tela conforma ilustrada na Figura 8.
Entradas são tidas como a unidade básica na qual uma informação é armazenada em um diretório. Entradas representam objetos do mundo real e são compostas por uma coleção de atributos. A seguir será apresentado como fazer a manipulação básica de entradas através do ApacheDS. Vale lembrar que para realizar as tarefas a seguir presume-se que o ApacheDS já possua uma conexão configurada e ativa junto ao diretório LDAP.
Para fazer a inserção de uma entrada, clique com o botão direito no mouse sobre algum item já existente no Diretório e selecione NEW > NEW ENTRY.
Na janela Entry Creation Method selecione a opção Create entry from scratch e clique sobre NEXT. A Figura 9 apresenta a ação descrita.
Na janela Object Classes selecione a(s) classe(s) de objeto(s) que irão compor a entrada. Para fazer a seleção, você deverá escolher um item presente na lista Avaliable Object Classes e depois clicar sobre Add. Feito isto, o referido item passará a compor a lista Selected Object Classes. Repita este processo até adicionar todas as classes de objetos necessárias. Clique sobre NEXT para avançar para próxima tela. A Figura 10 apresenta a tela descrita.
Na janela Distinguished Name deverá ser informado a entrada pai (Parent) bem como o RDN. Ao concluir a preenchimento desta janela clique em NEXT. Um exemplo desta configuração é apresentada na Figura 11.
Caso seja selecionada alguma classe de objeto que possua atributos de preenchimento obrigatório, estes serão exibidos na janela Attributes conforme ilustrado pela Figura 12. Para mudar o valor de algum atributo, clique sobre o campo Value na linha correspondente ao atributo em questão.
Caso algum destes atributos seja uma senha, será exibida a tela Password Editor (conforme ilustrado pela Figura 13). Preencha o campo Enter new password e selecione o método de Hash SHA. Após clique em OK.
Concluso o preenchimento dos atributos obrigatórios clique em FINISH.
Neste momento a entrada estará inserida no diretório LDAP.
A funcionalidade de renomear entrada é útil uma vez que se deseje alterar o nome de uma entrada já presente no diretório. O roteiro para renomear uma entrada é o seguinte:
Clique com o botão direito do mouse sobre a entrada e clique na opção Rename Entry.
Será exibida uma tela onde será possível alterar o RDN. Através desta alteração é que é possível renomear uma entrada. Altere o RDN para o novo nome da entrada e clique em OK. A Figura 14 apresenta a tela descrita.
Concluso este roteiro, a entrada estará renomeada.
A funcionalidade de exclusão de entrada é útil uma vez que se deseje excluir uma entrada presente no diretório. O roteiro para exclusão de uma entrada é o seguinte:
Clique com o botão direito do mouse sobre a entrada e clique na opção Delete Entry.
Será exibida uma tela solicitando a confirmação da exclusão e advertindo que eventuais entradas filho da entrada em questão também serão excluídas. Clique em OK para confirmar a exclusão. A Figura 15 apresenta a tela descrita.
Concluso este roteiro, a entrada estará excluída.
Atributos contêm as informações sobre um dado objeto. Todo atributo deve possuir um tipo e pode ser multi-valorado. A seguir será apresentado como fazer a manipulação básica de atributos através do ApacheDS. Vale lembrar que para realizar as tarefas a seguir presume-se que o ApacheDS já possua uma conexão configurada e ativa junto ao diretório LDAP.
Para fazer a inserção de um atributo, selecione a entrada a qual pertencerá o atributo e clique sobre o botão New Attribute conforme ilustrado na Figura 16.
Na janela Attribute Type selecione o tipo de atributo a ser inserido e clique em FINISH conforme ilustrado na Figura 17.
Ao retornar para a janela principal do ApacheDS, clique no campo VALUE e insira o valor do novo atributo conforme conforme ilustrado na Figura 18.
Concluso este roteiro, o atributo estará inserido.
A edição de um atributo presta-se a alterar as caracteristicas de um atributo já existente e pode ocorrer de duas formas distintas
Para editar o valor do atributo clique sobre uma entrada e depois clique sobre o campo VALUE do atributo em questão, conforme já exemplificado através da Figura 18.
Concluso este roteiro, o valor do atributo estará editado.
Para editar a descrição do atributo, ou seja, o tipo de atributo, clique com o botão direito do mouse sobre o atributo e clique na opção Edit Attribute Description.
Na janela Attribute Type selecione o novo tipo do atributo e depois clique em FINISH. Tal janela já foi ilustrada através da Figura 17.
Concluso este roteiro, a descrição do atributo estará editado.
A funcionalidade de exclusão de atributo é útil uma vez que se deseje excluir um atributo presente em uma entrada no diretório. O roteiro para exclusão de uma atributo é o seguinte:
Clique com o botão direito do mouse sobre o atributo e clique na opção Delete Value.
Será exibida uma tela solicitando a confirmação da exclusão. Clique em OK para confirmar a exclusão. A Figura 19 apresenta a tela descrita.
Concluso este roteiro, o atributo estará excluído.
LDIF é um formato de arquivo aceito pelo LDAP no qual pode ser descrito um conjunto de entradas ou sentenças de atualização. A seguir será apresentado como como executar LDIF já existentes através do ApacheDS.
Clique sobre o menu FILE > NEW
Expanda o item LDAP BROWSER, selecione o item LDIF FILE e clique em FINISH conforme ilustrado na Figura 20.
Feito isto, será exibida uma tela similar a da Figura 21.
Clique sobre BROWSE... para selecionar o conexão ao LDAP conforme ilustrado na Figura 22. Clique sobre a conexão desejada e depois clique em OK.
Na área de edição, insira o conteúdo do LDIF e posteriormente clique sobre o botão EXECUTE LDIF conforme ilustrado na Figura 23.
Se tudo ocorrer corretamente, o LDIF será executado e o diretório sofrerá as modificações que constam no LDIF. No caso deste exemplo o LDIF prestava-se a inserção de uma entrada chamada ou=people. Como pode ser visto, a inserção de tal entrada ocorreu perfeitamente e pode ser visualizada na Figura 24.
Efetue o download do Apache referente ao seu sistema operacional.
Efetue a instalação do Java JDK 11:
O próximo passo será configurar o Java na variável de ambiente no Windows. Indo em Propriedades;
Selecione Configurações avançadas do sistema;
Selecione Variáveis de Ambiente...
Dois cliques na opção Path nas Variáveis do sistema;
Clique em Novo e cole o caminho da pasta Bin do Java, conforme imagem abaixo, e dê OK;
Clique em Next;
Clique em I Agree;
Clique em Install;
Clique em Next;
Clique em Finish.
Instalação finalizada.
Objetivo
Este procedimento tem por objetivo orientar o cliente na importação do template de uma máquina virtual pré-configurada para ser o IdP de uma instituição que irá aderir a CAFe.
Caso sua instituição já faça parte da federação CAFe e não possui recursos para executar esse procedimento em uma VM paralela, você deve deixar isso claro no chamado pois o processo deverá ser executado com um agendamento junto a equipe de operação e suporte da CAFe. Esse cuidado é importante porque durante o procedimento a sua instituição ficará com o IDP fora da federação e os colaboradores ficarão sem o acesso federado.
Criado no formato OVF ()
Sistema Operacional Ubuntu 22.04.3 LTS com instalação otimizada para ambientes de virtualização;
Arquitetura de 64 bits;
8Gb RAM;
4 vCPU;
1 Disco rígido de 160 GBytes;
1 Adaptador de rede pré-configurado para usar ip fixo;
Criado no formato OVF ()
Sistema Operacional Ubuntu 22.04.3 LTS com instalação otimizada para ambientes de virtualização;
Arquitetura de 64 bits;
4Gb RAM;
2 vCPU;
1 Disco rígido de 80 GBytes;
1 Adaptador de rede pré-configurado para usar ip fixo;
Para instalação do MFA junto ao seu IDP fique atento para os requisitos necessários indicados no link a seguir:
Baixe o template da máquina virtual através do link:
Descompactar o arquivo. Importe o arquivo transferido em seu ambiente de virtualização.
Ligue o servidor virtual recém importado.
Importante !
Por uma questão de segurança de nossa VM o login remoto SSH para o usuário "root" foi desabilitado. Para logar com uma conexão remota no IdP via SSH você deve usar o usuário "cafe".
SSH na porta 22 padrão.
Informações para Login na VM:
usuário: cafe senha: 0p9o*I&U6y5t
Para os clientes que farão o uso do nosso template da CAFe o roteiro de instalação a ser seguido segue no link abaixo. Esse roteiro contempla todas as etapas de configuração auxiliadas pelo nosso instalador do IDP CAFe.
Configuração da logo para versão do Shibboleth 4.2.1
Antes de iniciar todo o processo de adequação da logo é necessário preparar o arquivo de imagem que contêm a logo da instituição. Precisamos fazer o seguinte, a imagem com a logo precisa ter as seguintes medidas em pixels, 270px de largura por 108px de altura.
Copie o arquivo pronto em formato .png para dentro do diretório /home/cafe do seu IDP.
Uma vez com o arquivo correto em seu /home/cafe copie para o seguinte diretório:
Após copiar o seu arquivo de logo para dentro do diretório /images do shibboleth, vamos agora alterar para o nome padrão que o shibboleth utiliza para carregar a imagem da logo na tela de login
Agora vamos acessar o script do shibboleth para executar um rebuild com a nova imagem da logo, para isso faça:
Acesse agora o portal https://sp.rnp.br/chimarrao e escolha a sua instituição, a sua tela de login agora deverá apresentar a sua nova logo !
Essa página contém todo material de suporte técnico criado por nossa comunidade federada, com a solução para as dúvidas mais frequentes de nosso clientes.
Este documento apresenta o procedimento necessário para solicitar a inclusão do bloco de metadados de um Provedor de Identidade IDP.
Durante a instalação do IDP é gerado um arquivo que contêm o bloco de metadado do provedor de identidade. Para que um provedor faça parte de uma Federação, uma das providências necessárias é a inclusão do bloco de metadado do provedor no arquivo de metadados da federação.
Os metadados da federação servem para informar aos seus participantes quais são os servidores "reconhecidos" e confiáveis.
O arquivo que possui o bloco de metadado do seu Provedor de Identidade IDP é o /opt/shibboleth-idp/metadata/idp-metadata.xml
Envie o arquivo de metadado para o endereço atendimento@rnp.br (caso já tenha um processo em andamento, basta mandar em reposta ao e-mail da equipe).
A equipe de operação CAFe então fará a verificação da integridade desse metadado, tudo estando certo esse metadado será inserido na federação Chimarrão para que seja iniciado a homologação do IDP.
Template | SHA |
256 |
1 |
Nesse conteúdo vamos aprender um pouco de como funciona a estrutura de receitas do RPilot e como trabalhar com as variáveis de instalação de uma receita.
Para que a receita possa funcionar de acordo com as informações da sua instituição, por exemplo, dados e informações necessárias e exclusivas da usa rede e infraestrutura, o RPilot fornece uma opção de inserção de variáveis específicas que a receita entende como sendo os parâmetros da instalação.
No caso do IDP da CAFe existem 26 variáveis necessárias para a instalação correta do IDP. Que podemos dividir em 3 subclasses:
Informações para certificado Shibboleth e metadado
Informação para conexão e configuração com base de diretório
Informações para configuração de um <virtualhost> Apache
ORGANIZATION -> Nome da Instituição por extenso. Exemplo: Rede Nacional de Ensino e Pesquisa
INITIALS -> A sigla da instituição. Exemplo: RNP
CITY -> Cidade da instituição. Exemplo: Brasília
STATE -> Unidade Federativa da instituição. Exemplo: DF
URL -> Endereço da página institucional. Exemplo: https://www.rnp.com
OU -> Sigla do setor técnico. Exemplo: DTI
CONTACTGIVEN -> Nome do responsável técnico. Exemplo: João Silva
CONTACTMAIL -> Endereço de email do contato. Exemplo: joao.silva@rnp.br
CONTACTSUR -> Sobrenome do contato apenas. Exemplo: Silva
LDAPATTR -> Atributo para autenticação na CAFe. Exemplo: uid, mail ou sAMAccountName
LDAPDN -> DN onde consulta os usuários na base LDAP. Exemplo: ou=pessoas,dc=rnp,dc=local
LDAPFORM -> Formato para construção das consultas na base LDAP. Exemplo: uid=%s,dc=rnp,dc=local
LDAPPWD -> Senha do usuário de BIND da base LDAP.
LDAPSERVER -> Endereço do servidor LDAP. Exemplo: 192.168.1.20
LDAPSERVERPORT -> Porta usada para conexão LDAP. Exemplo: 389 ou 636
LDAPSERVERPROTO -> Protocolo de comunicação LDAP. Exemplo: ldap:// ou ldaps://
LDAPSERVERSSL -> Valor 0 para SEM SSL e valor 1 para COM SSL.
LDAPSUBTREESEARCH -> Permitir consulta vertical abaixo do DN LDAP informado, por padrão essa opção deve estar 'true'. Exemplo: true
LDAPUSER -> Usuário de BIND para consulta no LDAP. Exemplo: uid=leitor-shib,ou=pessoas,dc=rnp,dc=local
DOMAIN -> Apenas o domínio da instituição. Exemplo: rnp.br
HN -> Apenas o nome do servidor, sem domínio. Exemplo: idp
HN_DOMAIN -> Apenas o domínio. Exemplo: cafe.rnp.br
INTERFACE -> Digitar o valor da Interface de rede do servidor. Exemplo: eth2, ens160, eth0, etc...
IP -> Digitar o IP do servidor IDP. Se estiver usando NAT digitar o IP NAT.
Ao terminar de preencher todos os campos clicar no botão "Próximo" ao final do rodapé.
Essa página tem por objetivo orientar na configuração do servidor cliente ao serviço do RPilot e prover um roteiro para instalação do IDP usando o recurso do RPilot.
Antes uma breve introduação ao serviço do RPilot. O RPilot funciona com um automatizador de processos, para o produto da CAFe ele irá auxiliar e executar para nossos clientes as ações de instalação do IDP, sua configuração e sua atualização. Ele conta com um motor shell script para executar suas receitas.
Requisitos:
Um servidor com uma instalação do Ubuntu 22.04
Conexão com a Internet
Necessário solicitar ao sistema RNP sua adesão ao serviço do RPilot, para isso você deve entrar em contato através do canal do nosso atendimento@rnp.br, nós envie um email com o assunto 'Adesão ao RPilot', lembrando que será apenas aceito aquelas instituições que já foram homologadas como aderentes ao sistema RNP.
Enviar um email para atendimento@rnp.br com assunto Adesão RPilot
Aguardar o retorno dos acessos para RPilot
Após receber os credencias realizar o primeiro acesso ao sistema RPilot
Servidores
Produtos
Receitas
Após seu autenticar no sistema você será encaminhado a tela de gerenciamento da sua instituição dentro do RPilot. Será apresentado um Menu lateral esquerdo conforme figura abaixo:
O nome da sua instituição será mostrado logo acima.
No menu procure por "Servidores", clique para acessar essa opção.
Na tela que será apresentada clique no botão azul "+ Adicionar Servidor", ele aparece ao lado direito da tela, veja figura abaixo:
Nesse momento será necessário passar os dados do servidor para que o sistema RPilot o identifique. Preencha os dados ali solicitados:
Nome do Servidor - "Use um nome fácil para sua identificação, sugiro que seja o nome usado em seu virtualizador, assim você saberá de qual máquina se trata"
Domínio - "Use o domínio que será usado para o DNS desse serviço, por exemplo rnp.br"
Host - "Use o nome que será usado para o DNS dese serviço, por exemplo cafe ou idp, sem o domínio apenas o nome"
Nome da interface de rede - "Colete o nome da sua inteface de rede do seu servidor, para isso use o comando em seu sistema Linux, por exemplo eth0, ens160, etc"
Endereço IP - "Passar o endereço IP do seu servidor, se estiver usando NAT passar o endereço NAT"
Máscara de Rede - "Passar a máscara de rede onde o servidor esta configurado, passar no formato de quatro octetos, por exemplo 255.255.255.0"
Ao final clicar no botão azul "Salvar"
Figura abaixo:
Você pode adicionar quantos servidores forem necessários
Após fazer o cadastro correto do seu serivdor no RPilot você será direcionado para a tela de detalhes do servidor, use essa tela para rever sua configurações e caso perceba algo de errado em sua configurações use o botão Editar no campo superior direto.
Nesse momento também será feita a instalação do agente do RPilot no seu servidor configurado. Para isso você vai precisar copiar o comando que aparece indicado em "Instrução de Instalação do Agente".
Atenção aos requisitos desse processo:
SO up to date
Estar logado como ROOT
Possuir o pacote CRUL em seu SO
Estando com os requsitos prontos basta executar o comando dentro do seu servidor e aguardar o fim da instalação. Quando o processo estiver terminado aguarde o campo "Status" ser alterado para agente instalado e ficar na cor verde.
Pronto! Nesse momento concluímos a instalação do Agente do Rpilot no seu servidor IDP. Agora iremos para as próximas etapas:
Escolha do Produto
Execução da Receita
Após seguir para o próximo passo de execução uma tela de revisão dos parâmetros será apresentado para que você possa verificar se as informações passadas para a receita de instalação estão corretas.
Se algo estiver incorreto você pode clicar no botão "Voltar" para corrigir. Se tudo estiver correto você pode então confirmar a execução da receita de instalação do IDP.
Processo de execução de receitas de instalação, atualização e ou comandos avulsos em seu servidor associado ao RPilot.
Nessa roteiro iremos aprender o processo de solicitar a execução de uma ação dentro do nosso servidor usando o RPilot. Nosso foco aqui será a instalação do IDP da CAFe então esse processo será direcionado para isso não dando ênfase em outros pontos. Caso tenha interesse em saber mais sobre a ferramenta RPilot acesse o manual do usuário através desse Link.
Esse é o painel de execuação. Nele podemos executar a receita de instalação do IDP da CAFe.
Repare que nele podemos confirmar o nosso servidor através das informações do servidor como Nome , Chave de registro , ID do Registro único, Domínio, Hostname e IP.
Também pode verificar o Status do agente RPilot instalado no seu servidor, confirme se ele está com o Status em verde com a informação "Agente Instalado".
Passos para execução:
Escolher o tipo de execução
Escoher a opção "Executar Receita"
Clicar no botão "Próximo"
Será mostrada uma tela para que você possa escolher seu "Produto" e abaixo você deve escolher qual "Receita" deseja executar:
Escolha o produto CAFe e a receita de Instalação do IDPvX.X.X conforme figura acima.
Essa página é aonde podemos acompanhar o processo das execuções feitas em nosso servidor pelo RPilot, todas as receitas executadas serão apresentadas aqui nesse painel.
Você será apresentado em uma painel com um formato em tabela, sendo ele dividio da seguinte forma:
6 colunas
Nome do Servidor -> Servidor no qual foi executado aquela receita.
Tipo de execução -> Se foi executado uma Receita, um Comando Avulso ou uma Geração de Certificado.
Data da Solicitação -> Data e hora da solicitação, início.
Data da execução -> Data e hora da execução, término.
Status -> Executando, Sucesso ou Erro.
Ações -> Log
Após a execução terminar, seja com Sucesso ou Erro você pode clicar emcima da linha ou ir em Ações nas 3 bolinhas e clicar em Log para verificar o log de execução da Receita.
Essa página ira apresentar e orientar o usuário do sistema RPilot em como executar uma receita do produto CAFe.
Para executar as receitas do produto desejado você deve acessar o dashbord do seu servidor
Para acessar o dashboard do seu servidor dentro do RPilot você precisa acessar a opção "Servidores" no menu de funcionalidades lateral esquerdo. Figura abaixo:
Para acessar o dashboard do seu servidor você pode ou clicar em cima da linha referente ao seu servidor, ele é clicável, ou clicar no ícone das 3 bolinhas dentro da coluna "Ações", Figura abaixo:
Após acessar o painel do dashboard será apresentado um pequeno painel de monitoramento e gerenciamento. Será nesse painel que você irá encontrar o caminho para as solicitações de execução das receitas dos seus produtos vinculados, conforme figura abaixo:
No canto superior esquerdo o indicativo do nome do servidor que está aberto, todas as suas ações dentro desse painel será para esse servidor.
No canto inferior esquerdo é possível ver o status do agente para esse servidor.
No canto superior direito temos o botão para solicitar a execução de uma ação em seu servidor.
Se você já realizou a instalação do agente do RPliot em seu servidor ele será mostrado conforme a figura acima, caso ainda não tenha feito essa etapa, acesse o procedimento neste
As orientações abaixo são destinadas aos responsáveis pela TI da instituição e que desejam disponibilizar um serviço via CAFe.
Caso seja um usuário verifique a página de requisitos de uso.
Para disponibilizar um serviço via federação (CAFe) basta a instituição entrar em contato com o Service Desk da RNP para iniciar o processo.
Em linhas gerais o processo consiste em:
Coleta de informações sobre o serviço por parte da RNP.
Coleta de metadados da instituição
Inserção dos metadados na federação
Ao gerar o seu certificado ele pode ser apresentado no formato .cer para isso se dá necessário o ajuste do arquivo para o formato .crt, abaixo uma explicação de como deve ser feita essa conversão: *Os nomes abaixo são meramente ilustrativos afim de ajudar no entendimento do processo.
Importante
Todo o processo de configuração acima se baseia no fato de ser usado o mesmo nome do certificado apache que o IdP já identifica por padrão, caso queira alterar o nome é preciso que seja feita a correção deste nome do certificado no arquivo de configuração do IdP, que fica em: /etc/apache2/sites-available/01-idp.conf
Antes:
~# SSLCertificateKeyFile /etc/ssl/private/chave-apache.key ~# SSLCertificateFile /etc/ssl/certs/certificado-apache.crt
Depois:
~# SSLCertificateKeyFile /etc/ssl/private/outro-nome-certificado-valido.key ~# SSLCertificateFile /etc/ssl/certs/outro-nome-certificado-valido.crt
Seguir o passos abaixo:
Se tudo der certo, o novo certificado será gerado e já gravado no devido diretório.
Após finalizar com sucesso o script o novo certificado foi gravado no seu novo arquivo de metadado, acesse o diretório /opt/shibboleth-idp/metadata e copie o arquivo "idp-metadata.xml". Esse arquivo deve ser enviado para equipe técnica da CAFe RNP para a atualização na Federação CAFe.
Importante !
Antes de começar é recomendado que seja feito o backup do arquivo "ldap.properties" em seu IdP. O arquivo fica no caminho: /opt/shibboleth-idp/conf
Considerar em todo texto abaixo que, OpenLDAP é a referência usada para identificar a base de diretório usada para a consulta do Shibboleth em seu IdP. Toda essa configuração foi homologada em um ambiente com os seguintes requisitos: Idp → Ubuntu 20.04, Shibboleth 4.2.1, Apache2 e Jetty9
Na imagem acima temos o arquivo "ldap.properties" no padrão do template, no exemplo acima a autenticação do IdP está ocorrendo pelo atributo "uid" configurado para OpenLDAP. Lembrando que cada insituição pode personalizar qual atributo deseja que seja usado para a autenticação, mas os recomendados são: uid, sAMAccountName e mail. O atributo sAMAccountName é usado na configuração com Active Directory(AD).
Agora iremos alterar o valor da variável usada pelo shibboleth (idp.authn.LDAP.userFilter), para executar o critério de consulta no OpenLDAP. Linha 25 do bloco de código abaixo
Na imagem acima fiz a alteração do valor na variável (idp.authn.LDAP.userFilter). Usei o operador lógico & para adicionar mais um critério de consulta na base e mantive a primeira regra e em seguida adicionei mais um regra para a validação da consulta, no exemplo usei o atributo memberof, esse atributo permite que o Shibboleth agora apenas consulte as contas que estiverem como membros deste grupo no OpenLDAP → (&(uid={user})(memberof=cn=GRP_SRV_CAFE,ou=GRUPOS,dc=homolog,dc=rnp)). O valor deste atributo precisa estar com o distinguished name DN do grupo criado que no meu caso foi cn=GRP_SRV_CAFE,ou=GRUPOS,dc=homolog,dc=rnp desta forma é possível estabelecer mais criteriosamente quais contas da sua base de diretórios tem permissão para usarem os serviços federados.
Existem outras possibilidades de serem criados tipos de critérios para uma autenticação, seguindo os passos anteriores eu abaixo darei mais um exemplo de como filtrar a autenticação do usuário, liberando apenas os que possuem uid e mail.
Também podemos usar o operador lógico OU do xml ( | ). No próximo exemplo o Shibboleth irá autenticar aquelas contas que possuem o atributo UID ou o mail
Antes de começar !
Esse roteiro foi preparado para ajudar as instituições clientes da CAFe RNP para executar a alteração do hostname e dominio de seu IdP em produção no serviço da CAFe. Esse roteiro foi homologado para o ambiente mais atualizado do IdP que possui a versão do sistema operacional Ubuntu 20.04 + Shibboleth 4.2.x.
É recomendando que o técnico que ira executar esse procedimento tenha conhecimento avançado ou seja familiarizado em sistemas operacionais Linux.
Importante !
É recomendado que se faça o backup dos arquivos que serão modificados durante o processo, caso algo de errado acontece poderemos restaura-los:
=================================================================================================
Backup do idp-metadata.xml:
sudo cp /opt/shibboleth-idp/metadata/idp-metadata.xml /home/cafe/idp-metadata.xml.bkp
Backup do idp.crt e idp.key:
sudo cp /opt/shibboleth-idp/credentials/idp.key /home/cafe/idp.key.bkp
sudo cp /opt/shibboleth-idp/credentials/idp.crt /home/cafe/idp.crt.bkp
Backup do arquivo hosts:
sudo cp /etc/hosts /home/cafe/hosts.bkp
Bakcup do arquivo idp.properties:
sudo cp /opt/shibboleth-idp/conf/idp.properties /home/cafe/idp.properties.bkp
Backup do arquivo 01-idp.conf:
sudo cp /etc/apache2/sites-available/01-idp.conf /home/cafe/01-idp.conf.bkp
===================================================================================================
Todos os arquivos foram copiados com a extensão .bkp para o diretorio home do usuário cafe, caso durante o processo ocorra um erro, para voltar o estado anterior do seu IdP basta copiar os arquivos para os devidos diretorios e retirar a extensão .bkp destes arquivos.
Vamos agora baixar o script de modificação e gerar novos arquivos com o novo hostname e novo dominio:
Baixar o script para o diretorio /tmp
Quando iniciar o script o mesmo irá te perguntar algumas informações, que precisam ser passadas para a exceução do script, tenha atenção neste etapa:
"Digite apenas o nome do host antigo: " Digitar aqui apenas o hostname antigo do seu IdP Ex: cafe-idp-antigo
"Digite apenas o dominio do host antigo: " Digitar aqui apenas o dominio antigo do seu IdP Ex: org.edu.antigo.br
"Digite apenas o nome do host novo: " Digitar aqui apenas o novo hostname do seu IdP Ex: cafe-idp-novo
"Digite apenas o dominio do host novo: " Digitar aqui apenas o novo dominio do seu IdP Ex: org.edu.novo.br
"Digite o nome do contato tecnico do servico (ex.: Joao da Silva): " Digitar o nome do contato técnico
"Digite o e-mail do contato tecnico do servico (ex.: joao.silva@instituicao.br): " Digitar o email do contato técnico
"Digite o nome da instituicao por exetenso (ex.: Rede Nacional de Ensino e Pesquisa): " Digitar por extenso o nome da instituição
"Digite a sigla da instituicao (ex.: RNP): " Digitar a SIGLA da instituição em maiusculo
"Digite o endereco do site da instituicao (ex.: www.instituicao.br):" Digitar a Url da instituição
"Digite o nome departamento da instituicao que eh responsavel por este servico (ex.: CPD): " Digitar o departamento resposável pelo IdP na instituição
"Digite o nome da cidade onde esta sediada a instituicao (ex.: Porto Alegre): " Digitar a cidade
"Digite por extenco o nome da Unidade Federativa onde esta sediada a instituicao (ex.: Rio Grande do Sul): " Digitar o nome da unidade federativa da instituição
Se tudo ocorrer sem problemas o script ira realizar as modificações necessárias e o seu IdP estará com o novo hostname e dominio configurados, porém no final do processo será necessário enviar para equipe técnica da CAFe RNP o novo "idp-metadado.xml" para o cadastro na CAFe produção. Esse arquivo você encontra no seguinte caminho:
Copiar o arquivo "idp-metadata.xml" e enviar o arquivo em anexo para equipe da RNP, para o cadastro do IdP com o novo hostname e dominio.
Importante !
Afinal deste processo o seu FQDN terá sido alterado por completo, logo será necessário que o DNS para o seu IdP seja também atualizado e esse novo DNS precisa permitir que as portas 80 e 443 estejam liberadas para o mundo, da mesma forma que estava antes. Ex: Antigo DNS cafe-idp-antigo.org.edu.antigo.br ; Novo DNS cafe-idp-novo.org.edu.novo.br
Esse roteiro tem como objetivo auxiliar as instituições clientes que desejam remover o serviço "fail2ban" do seu servidor IdP.
Atenção !
Esse roteiro foi todo homologado e baseado em um IdP com a versão template do IdP com o Ubuntu 20.04 + Shibboleth 4.2.x + fail2ban 0.10.2-2
Seguir as etapas abaixo para a remoção do serviço fail2ban da execuação do seu servidor IdP.
Primeiro logar em seu Idp e se tornar "root"
Executar o comando "systemctl status" e verificar se o serviço fail2ban está iniciado.
Executar o comando "systemctl stop fail2ban.service" e parar o serviço. Você pode executar novamente o comando da etapa 1 e verificar se o serviço foi parado.
Agora vamos desabilitar o serviço na inicialização do servidor, assim quando o mesmo for reiniciado o serviço não voltará a subir novamente.
Executar o comando "systemctl disable fail2ban.service", isso irá tirar o serviço da inicialização automática do servidor.
Pronto! O fail2ban não será mais iniciado no servidor.
Esse artigo foi criado para ajudar aquelas instituições que já possuem um serviço de segurança mais robusto e o fail2ban não é necessário, caso não saiba ou não esteja certo de como sua infraestrutura esteja configurada nós não recomendamos o desligamento deste serviço do seu IdP.
Essa responsabilidade será toda da equipe responsável pelo IdP institucional, a RNP não se responsabiliza por qualquer dano ao serviço ou a instituição causada pela escolha do desligamento do fail2ban do servidor IdP institucional.
Informe
Antes de iniciar qualquer ação deste roteiro primeiro verificar a versão do seu servidor Ubuntu.
Este roteiro so irá funcionar para aquelas instituições que já possuem a versão da VM IdP a partir da versão 20.04 do sistema operacional Ubuntu, com a versão 4.2.x do Shibboleth caso a sua instituição não esteja dentro deste requisito não realizar este operação e entrar em contato com o ServiceDesk da RNP, pois será necessário realizar a atualização do seu IdP.
Antes de começar !
Como a microsoft AD não implementa por padrão os atributos "schaDateOfBirth" e o "brPersonCPF" eles não são mapeados, com isso será necessário o uso de atributos que estejam vagos em seu AD para que os mesmos sejam mapeados para o Shibboleth em seu IdP. Nesse procedimento foi usado os seguintes atributos employeeNumber e employeeType
Nesse roteiro usamos o atributo employeeNumber para valores da Data de Nascimento e o atributo employeeType para valores do CPF
O shibboleth IDP em sua versão 4.2.x veio com algumas alterações na configuração de atributos, configurações essas que vieram para melhorar a manutenção e customização do IDP pelos responsáveis do serviço. Nessa versão tivemos a inlcusão de um novo recurso dentro do diretório /conf agora dentro desse diretório encontramos o sub diretório /attributes.
Esse sub diretório /attributes agora fica responsável por conter arquivos de configuração .xml que tratam sobre as especificações dos atributos suportados pelo IDP. Dentro desse diretório você verá os arquivos dividídos pelos seus respectivos schemas.
Para essa adequação do CPF e Data de Nascimento foi usado atributos que já estão mapeados pelo IDP dentro do schema .../conf/attributes/inetOrgPerson.xml e também já são atributos presentes no Microsoft AD.
Optamos por usar os atributos employeeNumber e employeeType
Dentro do seu Microsoft AD você precisa abrir o Editor de Atributos dos usuários e procurar pelos atributos employeeNumber e employeeType, veja figura abaixo:
Faça o preenchimento desses atributos seguindo a orientação de usar valores para Data de Nascimento em employeeNumber, sempre no formato AAAAMMDD e os valores para o CPF em employeeType, sempre no formato inteiro sem pontos e hífen.
Uma vez os valores populados em seu AD podemos agora configurar o shibboleth para que ele leia esse valores e entregue como se fosse o sachDateOfBirth e o brPersonCPF, passo a passo logo abaixo:
Abrir e editar o arquivo "attribute-resolver.xml", caminho: /opt/shibboleth-idp/conf e procure pelas entradas com id=brPersonCPF e id=schacDateOfBirth eles estão perto um do outro.
Vamos nesse momento alterar os valores de referencia desses dois atributos, temos que alterar a entrada da variável attributeNames="brPersonCPF" e attributeName="schacDateOfBirth" para os seguintes valores:
attributeNames="employeeType"
attributeNames="employeeNumber"
Procurar no arquivo de configuração na secção de Data Connectors a entrada <dc:ReturnAttributes>...</dc:ReturnAttributes>, ela faz referência aos atributos que serão retornados pelo seu IdP, essa configuração ainda deve ser feita no arquivo attribute-resolver.xml.
Informe
A inclusão do bloco de código deve estar contida dentro das tags "<resolver:AttributeResolver" e "</resolver:AttributeResolver>" que são as declarações de inicio e fim do arquivo attribute-filter.xml.
No exemplo citado estamos liberando os atributos CPF e Data de Nascimento apenas para o SP de teste da RNP e para os SPs dos serviços P1 e Pessoal do ICPEDU. Lembrando que os atributos devem existir no serviço de diretório da institução em forma de atributo do usuário.
Este tutorial apresenta os passos necessários para se fazer a geração de Chave e Certificado SSL.A seguir serão apresentados os requisitos bem como roteiro para a referida instalação.
Substituir o termo {exemplo.rnp.br} pelo nome do seu host de aplicação, por exemplo:
O resultado irá aparecer na tela, copie APENAS os valores que irão aparecer entre as TAGs
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
Após copiar esse valor substitua no arquivo de metadado aonde aparecer as TAGs
Legenda
Substituir $HOSTNAME, $NOME_SERVICO, $SIGLA_SERVICO, $DESCRICAO_SERVICO, $URL_SERVICO, $CONTATO e $EMAIL_CONTATO
Pronto ao final salve suas modificações no arquivo e envie o metadado para a equipe de operação da CAFe GTI/RNP através de um chamado pelo nosso canal de atendimento.
Seu metadado será inserido na federação Chimarrão para homologação e se aprovado será migrado para a federação CAFe.
Esse roteiro tem como objetivo auxiliar nossos clientes da CAFe em como ajustar as mensagens de login de acordo com suas necessidades institucionais.
Ajustar as mensagens na tela de login
Antes de começar !
Recomendado que seja criado um backup do arquivo "messages_pt_BR.properties" antes de começar as alterações abaixo.
Caminho para o arquivo: /opt/shibboleth-idp/messages
Qualquer problema após as modificações, basta retornar com o arquivo original.
Aviso
As mudanças realizadas abaixo foram homologadas em um ambiente com a VM template construída com o Sistema Operacional (Ubuntu 20.04 + Shibboleth 4.1.5). Os locais dos arquivos podem variar em outras versões do Template, ou se a instalação do seu IdP foi construído manualmente.
Esse roteiro ira ajudar na customização das mensagens da tela do login do seu IdP:
Todas as alterações serão feitas no arquivo messages_pt_BR.properties, para isso abra o arquivo com um editor de sua preferência, o caminho é /opt/shibboleth-idp/messages
Campo Username, alterando a mensagem:
Altere as entradas idp.login.username.label para alterar a mensagem do campos Username respectivamente, pode ser usado para informar aos clinetes que irão usar o seu IdP como devem proceder com o acesso a CAFe.
Para inserir uma nova mensagem basta apagar a mensagem atual em vermelho e escrever sua nova mensagem ao usuário, lembrando que a formatação deve ser respeitada, mantenha um espaço entre o valor = e o inicio da sua nova mensagem.
Feita a alteração basta salvar o arquivo com seu editor e executar o comando build.sh do shibboleth para que ele possa carregar as novas alterações. Para isso faça:
Nesse momento o script estará te perguntando em qual diretório padrão está a instalação do Shibboleth, por padrão é esse mesmo /opt/shibboleth-idp então basta apertar a tecla [Enter]
Aguarde a seguinte mensagem:
Essa mensagem indica que o rebuild ocorreu como esperado !
Agora vamos reinicar o shibboleth, faça:
Pronto ! Agora você pode verificar como ficou sua modificação, acesse o portal https://sp.rnp.br/chimarrao escolha sua instituição e clique em "Prosseguir" na próxima tela será apresentado a caixa de login e senha da sua instituição e se tudo deu certo a sua nova mesnagem estará aparecendo.
Gerar um novo certificado, procedimento . Após gerar um novo certificado não esquecer de enviar o contéudo do novo certificado gerado para equipe de operação da CAFe GTI/RNP, pois o mesmo deverá ser substituído no MOKA da CAFe.
Roteiro para auxiliar na configuração de um Service Provider utilizando um sistema Ubuntu
Este tutorial apresenta os passos necessários para se fazer a instalação do Shibboleth Service Provider (SP). Tal ferramenta será utilizada para atuar como provedor de serviços dentro da Federação CAFe.
A seguir serão apresentados os requisitos bem como roteiro para a referida instalação. É importante ressaltar que ao longo da instalação existem variáveis (que estão destacadas em negrito) que devem ser substituídas manualmente pelos seus respectivos valores.
Para executar este roteiro, espera-se que já tenham sido executados os seguintes roteiros anteriormente:
Ao longo deste roteiro serão utilizadas algumas variáveis que deverão ser substituídas para que ocorra o perfeito funcionamento dos arquivos de configuração. A seguir é apresentado um glossário para substituição das variáveis:
$DOMINIO_INST = Ex.: instituicao.br $ENDERECO_IP = Ex.: 111.222.333.444 $HOSTNAME = Ex.: servidor.instituicao.br
O conteúdo do certificado que deve ser incluído no arquivo acima é referente ao certificado gerado e armazenado no arquivo /etc/ssl/certs/$HOSTNAME.crt
Caso seja Ubuntu 18.04lts o arquivo está em /lib/systemd/system/shibd.service
#DAEMON_USER=_shibd - comentar a linha
DAEMON_USER=root - adicionar esta nova linha
** Após realizar a alteração, executar o stop do shibd e depois o start.
Sobre o roteiro
Esse processo foi homologado em ambiente com Ubuntu 20.04 + Shibboleth versão 4.2.1.
Esse script foi desenvolvido para os clientes da CAFe que fazem uso do nosso template de instalação do IDP. Não foi homologado em outros ambientes.
Abaixo as etapas para a instalação e configuração do Let's Encrypt no IdP da CAFe:
Primeiro baixar o script pelo nosso repositório:
Agora ajustar a permissão de execução do script:
Aplicar um update no repositório:
Executar o script:
Responda as perguntos do script
Apenas o nome do seu host, por exemplo, se o seu FQDN é "shibboleth-cafe.org.br" informe ao script somente "shibboleth-cafe".
Aqui digite apenas o domínio do seu FQDN, conforme exemplo acima "org.br".
Pronto! Agora só aguardar a execução do script e reniciar o serviço do Shibboleth.
Processo para homologação da instalação do IDP em seu servidor.
Para garantir que o processo de instalação do IDP via Receita no RPilot foi corretamente executado vamos rodar um script de homologação. Para fazer isso vamos realizar o download desde script utilizando a linha de comando abaixo:
Após fazer download, execute este script com permissão de root.
OK - Nao foram encontrados pontos impeditivos para o processo de adesao.
Envie o arquivo de log gerado (XYZ.log) para o Service
Desk da RNP para dar continuidade ao atendimento.
ERRO - Foram encontrados pontos impeditivos para o processo de adesao.
Verifique e corrija os erros e então execute novamente este script.
Esse script irá gerar um novo certificado auto assinado para o Apache. Para evitar problemas sugiro que faça um backup do certificado, primeiro, antes de executa-lo. Os certificados do Apache você encontrar no seguinte caminho: /etc/ssl/private - chave-apache.key e /etc/ssl/certs - certificado-apache.crt. O script executa uma tarefa de remoção nestes diretórios por isso sugiro que faça o backup copiando os arquvios acima para outro diretório, por segurança.
Configuração da logo.
Antes de iniciar todo o processo de adequação da logo é necessário preparar o arquivo de imagem que contêm a logo da instituição. Precisamos fazer o seguinte, a imagem com a logo precisa ter as seguintes medidas em pixels, 270px de largura por 108px de altura.
Copie o arquivo pronto em formato .png para dentro do diretório /home/... do seu IDP.
Uma vez com o arquivo correto em seu /home/... copie para o seguinte diretório:
Após copiar o seu arquivo de logo para dentro do diretório /images do shibboleth, vamos agora alterar para o nome padrão que o shibboleth utiliza para carregar a imagem da logo na tela de login.
Agora vamos acessar o script do shibboleth para executar um novo build com a nova imagem da logo, para isso faça:
Acesse agora o portal https://sp.rnp.br/chimarrao e escolha a sua instituição, a sua tela de login agora deverá apresentar a sua nova logo !
Esse roteiro tem como finalidade ajudar nossos clientes em como alterar o atributo principal de autenticação em seu IDP.
Em seu IDP, assim como em todo IDP, o mesmo possui um atributo chave que é usado como o atributo de autenticação principal. Em clientes que usam LDAP esse atributo é setado por padrão como sendo o "uid" e em clientes que usam o Microsoft AD esse atributo por padrão é setado como sendo o atributo "sAMAccountName".
Clientes nos perguntam se é possível alterar esse atributo principal de login na federação CAFe, e sim, é possível ! Abaixo eu descrevo os passos necessários para que façam esse ajusto em seus IDPs.
Será necessário apenas ajustar e alterar informações em um único arquivo do IDP, é o arquivo "ldap.properties". Sugiro que seja feito um backup do arquivo original antes de altera-lo.
sudo -i
cp -a /opt/shibboleth-idp/conf/ldap.properties /home/cafe/ldap.properties-original
Vamos ao procedimento de alteração, acesse o arquivo "ldap.properties" como root:
Faremos o exemplo usando um arquivo "ldap.properties" usando a configuração padrão de um LDAP, com isso o atributo principal será o "uid". Se você estiver usando um Microsoft AD esse atributo será o "sAMAccountName" não se preocupe basta fazer o mesmo procedimento.
As alterações irão ocorrer em apenas 4 linhas, tenha atenção nesse ponto.
Serão as linhas 25, 33, 40 e 55 procure pelas variáveis nesse ordem que segue:
Essas variáveis são as responsáveis por determinar qual atributo será usado para login em seu IDP, sendo assim em nosso exemplo o nosso atributo de autenticação no IDP está sendo o "uid". Porém houve a necessidade de se alterar esse atributo e a escolha do novo atributo para login, em nosso exemplo, será o atributo "mail". Como ficaria então essa nova configuração, veja:
Repare aonde mudamos os valores para as variáveis, veja como a estrutura deve ficar ao final:
Excelente ! Se o seu arquivo ficou conforme o final do processo anterior indica que você alterou o seu atributo principal de login, agora os usuários usarão o e-mail para logar em seu IDP.
Mas é agora ? Na tela de login a mensagem que aparece para os usuários ainda é a de inserir o "uid" ?
Sim, verdade ! Será necessário também customizar a frase da tela de login, afinal mudamos o meio de login do IDP e isso pode confundir os usuários. Então vamos lá !
Na imagem abaixo eu mostro como estava a minha frase na minha tela de login, veja:
Veja que a minha frase era "Seu nome.sobrenome" porque como os usuários usavam o "uid" para se logar, e em minha base o nosso "uid" é nome.sobrenome do usuário, mas eu alterei para o atributo "mail" conforme procedimento acima, então temos que alterar essa frase.
Para alterar a frase da tela de login do IDP vamos precisar mexer no arquivo "messages_pt_BR.properties". Sugiro que seja feito um backup desse arquivo original antes de altera-lo.
sudo -i
cp -a /opt/shibboleth-idp/messages/messages_ptBR.properties /home/cafe/messages_ptBR.properties-original
Agora vamos alterar a mensagem de login da tela do IDP. Edite o arquivo messages_ptBR.properties
Esse arquivo é muito grande não seria prático colocar todo ele aqui, então oriento você a procurar pela seguinte variável:
Essa é a mensagem que irá aparecer para os usuários do IDP, então altere como achar melhor para indicar aos seus usuários o que eles devem usar para se autenticar, no nosso exemplo usamos o atributo "mail" referente ao email, então nossa alteração será assim:
Salve o arquivo e vamos agora refazer o "build" do IDP:
Repare que na etapa de número (7) o script está lhe fazendo uma pergunta, aonde é o diretório instalado do seu IDP, como o nosso template usa o padrão, basta pressionar a tecla <enter> que o script irá seguir com o restante. Feito isso acabamos, agora vamos reiniciar o serviço do Jetty9
Veja como ficou agora a minha tela de login:
Pronto, você alterou o seu atributo de login prinicipal e alterou a frase da sua tela de login.
Esse procedimento visa alterar o nível do log do IdP para o modo DEBUG, com isso mais informações serão gravadas e informadas para uma melhor analise do problema.
Altere o nível do log para DEBUG. Abra o arquivo /opt/shibboleth-idp/conf/logback.xml e altere as linhas 24,25 e 28 abaixo:
Essa etapa consiste em orintar o usuário do serviço RPilot a realizar a associação do produto CAFe em seu servidor configurado no RPilot.
Após realizar a instalação do agente RPilot em seu servidor chegou o momento de escolher o produto no qual deseja vincular a sua conta. Para isso você deve navegar pelo menu latreral esquerdo, selecione a opção "Produtos Vinculados", figura abaixo:
Nessa tela no canto superior direito haverá um botão azul com a mensagem "Vincular Produto", clique nesse botão.
Será mostrado um menu no centro da tela
Nesse momento você poderá selecionar aquele produto no qual deseja associar a sua conta e usar os processos nele presentes para execução em seu servidor cadastrado. Como nesse caso estamos fazendo a Adesão de um IDP CAFe você irá selecionar o produto CAFe.
Após selecionar o produto CAFe você verá em sua pratilheira virtual o produto ali selecionado.
Lembrando que você pode ter mais de um produto registrado em seus vínculos
Pronto! Nesse momento você já tem acesso a todas as receitas de configuração, instalação e atualização da CAFe para a sua conta RPilot.