1 Brasília, 23 de abril de 2013
Guia de Instalação e Configuração do Plugin de Sincronização versão 1.3 Responsáveis: Salvador Melo/ Márcio Batista/ Lino Muniz/ Ricardo Zago/ Andreza Hermes
Sumário
Sumário ... 1
1. Introdução ... 2
2. Instalação do plugin ... 2
3. Configurando chave e senha de autenticação de WebService ... 5
4. Obtenção dos dados da plataforma Arouca ... 5
5. Passos para assinatura certificado com OpenSSL ... 7
6. Cadastrando um curso para sincronização com a plataforma Arouca ... 9
7. Homologação de concluinte ... 13
2
1. Introdução
SYNCICCAROUCA é um plugin para Moodle 1.9.x que faz sincronização de alunos ingressantes e concluintes do Moodle para Plataforma Arouca.
A sincronização é feita em nível de curso entre os dois ambientes. O Moodle envia para Arouca não só a relação dos alunos matriculados como também os alunos que concluíram o curso. Além disso, esse módulo recupera o link do certificado emitido pela Plataforma Arouca e envia para o e-mail do aluno. Todo o processo de comunicação entre os dois ambientes é automática. O processo é executado por meio do sistema de cron do Moodle.
Requisitos:
• O sistema de login da sua plataforma moodle deverá esta integrado a federação ou os campos id number e user name, padrões do moode, deverá ser preenchido com o CPF dos usuários da plataforma;
2. Instalação do plugin
Para instalar o plugin de sincronização é necessário obter a pasta com os seus arquivos de instalação, disponível na GT de TI do Moodle Comunidade, clique aqui. Para baixá-lo é necessário que você esteja cadastrado no GT de TI. Caso não tenha cadastro, acesse o nosso
suporte através do link https:/ / sistemas.unasus.gov.br/ suporte/ e solicite o seu cadastro.
De posse do arquivo synciccarouca.zip, descompacte-o e coloque a pasta synciccarouca no diretório admin/report que fica em MOODLE_INSTALL_DIR/admin/report.
A pasta synciccarouca descompactada deve conter os seguintes arquivos e subpastas listados abaixo:
3
Figura 1: Pasta do plugin Synciccarouca descompactada
Após descompactar a pasta com os arquivos, acesse a plataforma moodle com login de administrador, navegue até o menu “ administrção do site” e clique na opção “ Aviso” . Neste momento o plugin começara a ser instalado.
Caso a instalação tenha ocorrido bem, você verá a palavra sucesso em todas as mensagens e no final da tela a frase “ synciccarouca foram configuradas corretamente” , conforme figura abaixo. Para começar a usá-lo basta acessar o mesmo e realizar as configurações necessárias.
4
5
3. Configurando chave e senha de autenticação de WebService
O primeiro passo a ser realizado para conexão com a Plataforma Arouca é a configuração do certificado digital. Esta configuração é feita editando o arquivo config_dist.php localizado na pasta de instalação do plugin. Abra o arquivo e insira as informações como Endereço do arquivo de certificado digital no servidor; Senha da chave privada do certificado e Endereço web do WSDL conforme figura abaixo:
Figura 3: Arquivo "config_dist.php" nova versão
Após a inserção das informações basta renomear o arquivo config_dist.php para config.php
Obs.: você não pode deixar de renomear o arquivo config_dist.php, caso contrário sua conexão com a plataforma Arouca não será estabelecida.
Este procedimento só poderá ser realizado pelo administrador do servidor, caso você seja apenas administrador do moodle, deverá entra em contato com o administrador do seu servidor para que ele possa configura o referido arquivo.
4. Obtenção dos dados da plataforma Arouca
O que é SSL?
Secure Socket Layer (SSL) é um padrão global em tecnologia de segurança que abre um canal criptografado entre o seu cliente de web service e o servidor da plataforma Arouca para garantir que todos os dados transmitidos sejam sigilosos e seguros.
Ao escolher ativar o SSL, você terá que responder algumas questões sobre a identidade do seu órgão. Será criado para seu cliente do web service um par de chaves criptográficas uma chave privada (Private Key) e uma chave pública (Public Key). A chave privada deverá ser mantida segura onde se encontra o seu Web Service.
6
Esse par de chaves será utilizado para geração de uma requisição de assinatura de certificado (Certificate Signing Request, CSR) um arquivo de dados contendo os detalhes do cliente do WS e do órgão. Você deverá enviar esta CSR através do formulário de suporte do site da Unasus; seus dados serão validados e se estiverem corretos seu certificado digital será emitido.
O certificado digital emitido será necessário para o estabelecimento da conexão segura e para identificar seu cliente web service junto à plataforma Arouca.
Procedimento para acesso ao web service da Plataforma Arouca
Obrigatoriamente, o órgão deverá criar dois certificados com chaves privada diferentes. Um para acesso ao ambiente de homologação e outro para acesso ao ambiente de produção da plataforma Arouca.
Cada ambiente possui uma CA (Autoridade Certificadora) diferente. Ambas servem apenas para autenticação do WS.
Primeiramente o órgão deve solicitar assinatura para o certificado de acesso ao ambiente de homologação, a fim de fazer testes de inserção e pesquisa pelos métodos do WS Arouca. Finalizado os testes, o órgão deve solicitar outra assinatura de certificado para acesso ao ambiente de produção. A seguir iremos explicar como gerar o certificado digital.
Uma chave privada tem este formato: ---BEGIN RSA PRIVATE KEY--- ....
---END RSA PRIVATE KEY---
Uma chave privada encriptada com senha tem este formato: ---BEGIN RSA PRIVATE KEY---
Proc-Type: 4,ENCRYPTED
DEK-Info: DES-EDE3-CBC,39045515E6713255 ....
---END RSA PRIVATE KEY--- Um certificado tem este formato:
---BEGIN CERTIFICATE--- ....
---END CERTIFICATE---
Um certificado é associado a um DN, exemplo de um DN:
CN=SE-UNA-SUS,OU=Secretaria Executiva UNA-SUS,O=Ministerio da Saude,L=Brasilia,ST=Distrito Federal,C=BR
7
EM PHP quando usamos um certificado cliente, normalmente cria-se um arquivo XXX.pem, composto da chave privada encriptada e o certificado, ou seja, é composto por:
---BEGIN RSA PRIVATE KEY--- Proc-Type: 4,ENCRYPTED
DEK-Info: DES-EDE3-CBC,39045515E6713255 ....
---END RSA PRIVATE KEY--- ---BEGIN CERTIFICATE--- ....
---END CERTIFICATE---
Sendo que a senha necessária para o PHP, é a senha utilizada na encriptação da chave privada. Caso você tenha uma chave privada não encriptada, pode-se encripta-la em LINUX usando o comando:
openssl rsa -des3 -in xxx.key -out xxx.key2 (onde xxx.key é um arquivo com apenas a chave privada não encriptada e xxx.key2 é a chave privada encriptada com a senha solicitada ao rodar o comando)
comando similar em outras plataformas.
Em LINUX, um jeito simples de concatenar dois arquivos (exemplo, chave encriptada chamada aqui de xxx.key2 e certificado xxx.crt) para gerar um arquivo único para uso no PHP exemplo xxx.pem cat xxx.key2 xxx.crt > xxx.pem
5. Passos para assinatura certificado com OpenSSL
1º PASSO Gerando o CSR
Um CSR é um arquivo contendo as informações para a solicitação do seu certificado. Para gerar um par de chaves, pública e privada, e o CSR utilize as instruções:
openssl req -newkey rsa:2048 -nodes -keyout [nome da sua chave privada].key -out [nome do arquivo].csr
8
Isso gera dois arquivos. O arquivo [nome da sua chave privada].key contém a chave
privada.
Observações:
Não compartilhe esse arquivo com alguém; Proteja a sua chave com cuidado;
Será solicitado que você forneça os dados a serem incluídos no seu CSR. Em alguns campos haverá um valor padrão;
Se você colocar ‘.’, o campo ficará em branco;
Não abrevie as informações nem utilize caracteres especiais incluindo letras acentuadas.
Country Name (C) (Código de país de 2 letras), deve ser preenchido como BR State or Province Name (ST) (Estado, por extenso)
Locality Name (L) (Cidade, por extenso) Organization Name (O) (Nome do Órgão)
Organizational Unit Name (OU) (Departamento, setor)
Common Name (CN) (Nome utilizado para identificar a aplicação cliente) Email Address (E) (Endereço eletrônico)
As seguintes informações são opcionais.
A challenge password (Senha para uso da chave privada. Se fornecida deve ser recordada, pois será necessária em configurações posteriores.)
An optional company name (Nome alterantivo)
Nota: Os campos email address, optional company name e challenge password podem ser deixados em branco na solicitação de um certificado de servidor.
Pronto. Seu CSR foi gerado.
9
Após a geração do arquivo de CSR, acesse o sistema de suporte técnico SE/UNASUS pelo endereço eletrônico (https:/ / sistemas.unasus.gov.br/ suporte/) e crie um chamado com Assunto:
“ Assinatura Certificado AroucaHomologação” para acesso ao ambiente de homologação ou com assunto: “ Assinatura certificado Arouca Produção” para acesso ao ambiente de produção.
Enviado o chamado, aguarde retorno do atendimento . 3º PASSO Utilizando o seu certificado
Você receberá um arquivo .zip contendo 2 arquivos do suporte Arouca: • Seu certificado – [seu certificado assinado].crt
• Certificado AC Arouca – [ACArouca_Ambiente].crt
Nota: Caso solicite certificado para o ambiente de homologação , por exemplo, você receberá o certificado da AC Arouca_homologação . Cada ambiente possui uma AC diferente.
Descompacte os arquivos e salve-os no diretório de sua preferência. Seu certificado e chave privada estão em formato PEM. Dependendo do seu cliente, diferentes formatos de chave/certificado podem ser necessários.
Caso precise dos certificados como PKCS#12, utilize o comando abaixo para converter o arquivo:
openssl pkcs12 -export -out [nome do arquivo].p12 -inkey [nome da sua chave privada].key -in [seu certificado assinado].pem -certfile [ACArouca_Ambiente].pem
A seguir será solicitada uma senha.
6. Cadastrando um curso para sincronização com a plataforma Arouca
Após a configuração da chave e senha de autenticação de WebService e hora de configura o plugin para que o mesmo possa enviar os dados do seu curso no moodle para a Plataforma Arouca. Para isso acesse o moodle com login e senha de administrador, navegue até o menu administração do site e, em seguida, cliquem em relatório -> Sync Arouca. A tela mostrada na figura abaixo será aberta.
10
Figura 4: Tela de Relatório de Sincronização com a Plataforma Arouca
Na tela acima clique na aba configurações, em seguida clique na função “ Cadastrar Nova Sincronização de Curso” . A nova janela abaixo será aberta.
11
Nesta nova tela escolha o curso a ser sincronizado e insira Id do curso na Plataforma Arouca” e “ Id da oferta na Plataforma Arouca” .
Obs.: Para obter Id do curso na Plataforma Arouca” e “ Id da oferta na Plataforma Arouca ” é necessário que a oferta do seu curso tenha sido previamente cadastrada junto a Plataforma Arouca. Caso você não tenha essas informações procure o seu coordenador ou responsável pelo cadastro da ofertas na plataforma Arouca para obtenção dos dados.
Na opção concluinte na oferta, marque a opção SIM, você não poderá deixar de marcar essa opção.
Outro ponto importante da sincronização é a emissão de certificado/declaração caso o seu curso forneça. Para que o certificado/declaração seja emitido automaticamente pela Arouca é necessário cadastra o layout do mesmo na Arouca. Caso você não tenha essas informações procure o seu coordenador ou responsável pelo cadastro da ofertas na plataforma Arouca.
No campo “ Envio de Certificado por E-mail” , mostrado na tela de cadastro de sincronização de curso, você deve customizar a mensagem com o link de certificado a ser enviado por e-mail.
Abaixo estão listadas as expressões das variáveis que podem ser inseridas no campo “ Envio de Certificado por E-mail”.
{USUARIO_NOME} : imprime o Nome do Aluno;
{USUARIO_NOME_COMPLETO}: imprime Nome e sobrenome completo do Aluno; {CURSO_NOME}: imprime Nome do curso no Moodle;
{CURSO_ABREV}: Nome breve do curso no Moodle; {CURSO_URL}: Link do curso no Moodle;
{CERTIFICADO_URL}:Link do certificado da Plataforma Arouca;
Abaixo segue o exemplo de configuração de uma mensagem para emissão de certificado disponível na Plataforma Arouca:
12
13
7. Homologação de concluinte
O plugin de sincronização com a plataforma Arouca foi desenvolvido para que a homologação dos concluintes só possa ser efetivada com autorização do gestor do curso ou responsável. Para isso, a pessoas que ira efetivar a homologação deverá acessar o plugin e clicar na aba homologar concluinte e selecionar o curso desejado.
Após selecionar o curso desejado e clicar em Avançar, Será apresentada uma tabela conforme figura abaixo, listando todos os usuários que finalizaram o curso com nota para aprovação. Nela, terá informações como nome do usuário, nota, tipo de matricula (manual ou automática), data de ingresso e data de finalização. No final da tabela temos o campo para homologação, basta marcar a caixa de seleção e clicar em homologar.
Figura 7: Lista de usuários que finalizaram o curso com nota para aprovação
Quando o gestor homologa um usuário, o mesmo recebe uma mensagem automática via e-mail com o certificado de conclusão de curso enviado pela Plataforma Arouca, caso o curso ofereça certificado e o mesmo tenha sido previamente cadastra na Arouca.
14
8. Relatórios
No que tange o relatório, o plugin de sincronização pode nos fornecer uma gama de informações. Abaixo está a descrição cada uma das opções do campo status.
• Ingressantes registrados no curso moodle: apresenta a lista de todos os alunos matriculados no curso.
• Ingressantes sincronizados com a Plataforma Arouca: apresenta a lista de todos os alunos cadastrado no curso que já tiveram seus dados sincronizados com a plataforma Arouca;
• Ingressantes não sincronizados com a Plataforma Arouca - Falha de Web Service: apresenta a lista de alunos que tiveram problemas com a sincronização de dados com a plataforma Arouca, neste caso o administrador deve identificar e corrigir o problema para que a sincronização possa ser efetivada.
• Concluintes homologados na plataforma moodle: apresenta a lista de todos os usuários que finalizaram o curso no moodle e obtiveram nota para aprovação. Estes usuários serão apresentados na lista a ser homologada pelo gestor.
• Concluinte homologado pelo gestor: apresenta a lista de todos os alunos os quais obtiveram a provação no curso e tiveram sua homologação efetivada pelo gestor. • Concluinte não sincronizado com a Plataforma Arouca - Falha de Web Service: apresenta a lista de concluinte homologados pelo gestor, cuja a informação de homologação não foi enviado para a Plataforma Arouca por algum tipo de falha. Neste caso o administrador do Moodle deverá identificar e corrigir o problema para que a informação de homologação possa ser enviada para a Arouca.
• Certificado emitido: apresenta a lista de usuários que já esta com o certificado disponível na plataforma Arouca e pronto para emissão.
• Certificado enviado: apresenta a lista de usuários que tiver mensagem enviada para o e-mail com o link para emissão de certificado.
• Certificado não emitido - Falha de Web Service: apresenta a lista de usuários que não tiveram seu certificado emitido por falha de comunicação com a plataforma Arouca.
15
