Pular para o conteúdo principal
Version: 3.20

Task Manager Cookbook

Introdução​

Este livro irá explicar da forma simples como utilizar o módulo Task Manager no senhasegura para automatizar a execução de atividades privilegiadas.

A quem se destina este cookbook?​

O senhasegura Task Manager Cookbook foi escrito para ambientar implantadores, usuários e administradores de sistemas que precisam executar tarefas privilegiadas em servidores, de forma automatizada, sem a necessidade de compartilhar credenciais ou conceder acesso a um operador.

O que você precisa entender antes​

Este livro requer que o leitor já tenha tido uma primeira experiência com o senhasegura e possua uma instância da solução com no minímo um dispositivo e uma credencial cadastrados. Também é importante entender como inserir templates de execução no sistema e como funcionam os executores de Troca de senha.

Antes de continuar a leitura, caso ainda não tenha tido essa primeira experiência, ou executado uma troca de senha você deveria consultar o seguinte conteúdo:

  • Primeira Experiência Cookbook: Esse cookbook explica de forma simples o uso do senhasegura desde a sua instalação até o uso das funções básicas.

  • Troca de Senha Cookbook: Esse cookbook irá explicar da forma simples como solicitar e executar uma troca de senha.

Símbolos usados neste cookbook​

Este livro usa os seguintes símbolos para destacar informações que devem ser levadas em consideração para o melhor uso de senhasegura :

info

Info - Informações úteis que podem tornar o uso da solução mais dinâmico.

caution

Caution - Ações e itens que não podem ser ignorados.

  • commands : Dados que devem ser inseridos da mesma forma como descrito neste livro.

  • URLs : Caminhos para acessar páginas da web.

  • <KEYS> : Caminhos de teclado que serão usados para realizar ações.

Configurando o seu Task Manager​

Task Manager necessita que algumas configurações sejam feitas antes de selecionar os scripts e agendar execuções. Neste capítulo vamos entender os pré-requisitos para utilização do módulo e as configurações iniciais necessárias.

Pré-requisitos​

Para utilizar este módulo é necessário:

  • Ter um dispositivo1 configurado com uma porta para acesso remeto, de acordo o sistema. Exemplo:

    • SSH 22 (Linux ou Unix)

    • RPC 135, RM 5985 ou 5986 (Windows)

  • O dispositivo possuir uma credencial2 com permissão para executar os scripts remotamente.

  • Possuir um ambiente e um sistema, cadastrados no senhasegura

  • Ter um motivo para execução, cadastrado.

  • Possuir um template de execução cadastrado.

  • Criar um grupo de acesso para este módulo.

Cadastrando um ambiente​

Um ambiente no senhasegura se refere onde aquela task será executada.

Para exemplificar podemos dizer que a task que criaremos será executada no ambiente onde as atividades de desenvolvimento são realizadas, ou seja, nosso ambiente será o de Desenvolvimento.

caution

Esta configuração é apenas uma identificação, não irá influenciar em nenhuma configuração real do ambiente.

Outros exemplos de ambientes podem ser: Homologação, Producão e outros.

info

Caso você já tenha um ambiente cadastrado no senhasegura siga para a próxima seção.

Para cadastrar um ambinte siga as instruções:

  1. Acesse menu Configurações ➔ Parâmetros do sistema ➔ Segmentação ➔ Ambientes

  2. Clique no botão Exibir ações e selecione a opção Novo

  3. Defina o nome do ambiente e clique em Salvar como na figura ambiente-ptbr

Formulário de cadastro de ambiente

Cadastrando um sistema​

Sistemas no senhasegura são as plataformas onde os ambientes estão presentes.

Utilizando o exemplo anterior podemos dizer que nosso ambiente de desenvolvimento esta instalado em um sistema de nuvem, ou seja, nosso sistema será Cloud.

caution

Esta configuração é apenas uma identificação, não irá influenciar em nenhuma configuração real do sistema.

Outros exemplos de sistemas podem ser: Mobile, Web, Intranet e outros.

info

Caso você já tenha um sistema cadastrado no senhasegura siga para a próxima seção.

Para cadastrar um sistema siga as instruções:

  1. Acesse menu Configurações ➔ Parâmetros do sistema ➔ Segmentação ➔ Sistemas

  2. Clique no botão Exibir ações e selecione a opção Novo

  3. Defina o nome do sistema e clique em Salvar como na figura sistema-ptbr

Formulário de cadastro de sistema

Cadastrando um motivo​

Para a execução de uma task é importante que se defina um motivo pelo qual esta atividade deve ser executada.

info

Caso os motivos que você necessita já estejam cadastrados no senhasegura siga para a próxima seção.

Para cadastrar um motivo siga as instruções:

  1. Acesse menu Task Manager ➔ Configurações ➔ Motivos

  2. Clique no botão Exibir ações e selecione a opção Novo

  3. Defina o motivo no campo Nome e selecione o tipo de atividade como na figura motivo-ptbr

Formulário de cadastro de motivo

Cadastrando um template​

Templates são o conjunto de comandos a serem executados para realizar uma atividade através de um plugin(executor).

Algumas atividades necessitam de uma ordem e comandos específicos, podemos explicar isso da seguinte maneira:

Um template que tem o objetivo de instalar pacotes de atualização terá etapas de execução diferentes de um template para parar ou reiniciar um serviço.

É importante ressaltar que apesar de serem templates diferentes podem utilizar o mesmo plugin para execução ou não, já que deve se levar em conta as tecnologias e tipos de sistemas envolvidos.

Para inserir um novo template task manager acesse o relatório de templates: Execuções ➔ Configurações ➔ Templates

Siga as instruções:

  1. Clique no botão Exibir ações do relatório

  2. Clique na opção Novo template

  3. No formulário de cadastro exibido insira o nome que este template terá no campo Nome.

    info

    Escolha um nome que remeta ao objetivo do template para que seja fácil encontra-lo sempre que houver necessidade. Ex: Linux - Reiniciar serviços

    Formulário de cadastro de template

  4. Selecione o plugin que este template irá utilizar na caixa de opções do campo Executor.

  5. Selecione a opção Task Manager na caixa de opções3 do campo Tipo de execução.

  6. Selecione entre as opções se deseja que o template esteja ativo ou não no campo Ativo?. Assim ao criar uma task este template poderá ser escolhido ou omitido das opções disponíveis.

  7. No campo Conteúdo insira os comandos que serão executados na task.

    info

    O botão Visualizar TAGs, como mostra a figura template-ptbr apresenta uma descrição para o uso das TAGs nos templates

    Para exemplificar as sintaxes utilizadas nos templates apresentamos abaixo um template exemplo de reiniciamento de serviço:

    info

    Para comentários utilize o caractere sustenido '#' no início da linha.

    ## Este é um exemplo de comentário

    #Verifica o status de todos os serviços
            expect "*$"
            exec "service --status-all"

            #Acesso ao usuário root
            expect "*$"
            exec "sudo su"

            #Insere a senha do usuário root
            expect "*:"
            exec "[#AUTH_PASSWORD#]"

            #Para o serviço
            expect "*#"
            exec "service [#VARIAVEL#] stop"

            #Exibe o status do serviço
            expect "*#"
            exec "service [#VARIAVEL#] status"

            #Reinicia o serviço
            expect "*#"
            exec "service [#VARIAVEL#] restart"

            #Finaliza a execução da task
            expect "*#"
            end

    Observe que o serviço a ser reiniciado não está mencionado no template, isto se dá porque estamos utilizando aqui a opção de tags que veremos no próximo capítulo. Entretanto em seu template, se desejar, insira todos os detalhes da execução desejada.

  8. Após preencher os campos clique em Salvar

Alterando um template​

Para realizar a alteração no conteúdo de algum template, siga as instruções:

  1. Acesse o relatório de templates: Execuções ➔ Configurações ➔ Templates

  2. Escolha o template que deseja alterar.

    Você pode utilizar o filtro no topo do relatório e encontrar o template através do seu: Executor, Tipo e outros itens.

  3. Quando encontrar o template clique no botão de ação respectivo e selecione a opção Alterar template

  4. Altere as informações que desejar e ao terminar clique em Salvar.

Visualizando o histórico de alterações​

Todas as alterações nos templates são registradas pelo senhasegura que armazena um histórico que auxilia na consulta do que foi alterado e até mesmo da restauração do template de determinado período.

Para visualizar o histórico de alteração de um template, siga as instruções:

  1. Acesse o relatório de templates: Execuções ➔ Configurações ➔ Templates

  2. Escolha o template que deseja visualizar as mudanças.

    Você pode utilizar o filtro no topo do relatório e encontrar o template através do seu: Executor, Tipo e outros itens.

  3. Quando encontrar o template clique no botão de ação respectivo e selecione a opção Histórico das alterações do template

    Relatório de alterações do template

  4. No relatório exibido será possível visualizar a data de alteração e suas versões.

  5. Clique no botão de ação da versão que deseja visualizar o conteúdo como mostra a figura templatehis-ptbr.

    Quando você visualizar um template antigo um botão para restaurar o template será exibido. Se desejar restaurar versão clique no botão Restaurar e automaticamente o template será atualizado para a versão anterior desejada.

    info

    Ao restaurar um template o senhasegura registrará essa restauração uma nova versão do template, permitindo com que você não perca nenhuma versão mesmo após alguma restauração.

Cadastrando um grupo de acesso​

Para que a task criada seja visualizada é preciso que os usuários que irão a executar estejam em um grupo de acesso para as tasks. Para criar este grupo de acesso siga as instruções

  1. Acesse o menu Task Manager ➔ Configurações ➔ Grupos de acesso

  2. Clique no botão Exibir ações do relatório

  3. Clique na opção Novo grupo

    Formulário de cadastro de grupo de acesso do Task Manager

  4. Defina as permissões do grupo e se os membros deste deverão justificar e ou solicitar aprovações para executar uma task, como mostra a figura grupodeacesso-ptbr

  5. Siga para a guia Critérios e escolha os Ambientes e Sistemas onde os membros deste grupo poderão executar as tasks

  6. Siga para a guia Usuários e clique no botão Adicionar e selecione os usuários que faram parte deste grupo e em seguida clique em Adicionar selecionados como na figuragrupodeacessousu-ptbr.

    Formulário de cadastro de usuários para o grupo de acesso do Task Manager

    Caso tenha selecionado um usuário por engano clique no botão Remover e do mesmo modo selecione os usuários que deseja remover.

  7. Se você definiu na guia Configurações que os membros do grupo necessitam de aprovação é importante que a guia Aprovadores seja preenchida.

    Do mesmo modo que os usuários foram selecionados no passo anterior, selecione os aprovadores.

    info

    Caso a aprovação seja em níveis será necessário também definir o nível de aprovação de cada um.

    info

    Você pode verificar as suas solicitações de execução de task através do menu Task Manager ➔ Minhas solicitações.

    Se você for um aprovador verifique as solicitações feitas para você através do menu Task Manager ➔ Minhas aprovações

Com estas configurações realizadas você já poderá realizar o cadastro e a execução de uma task como veremos no próximo capítulo. % Redefinindo a pasta atual do capitulo

Task Manager e suas ações​

Agora que as configurações necessárias foram definidas o Task Manager poderá começar a ser usado para fazer a gestão das tasks privilegiadas em seus dispositivos.

Para entender melhor o uso do módulo podemos apresentar o seguinte cenário:

"Em uma organização existe um colaborador contratado que exerce todas as atividades relacionadas a gestão e o monitoramento do backup do sistema. Dentro de uma semana esse colaborador sairá de férias e ficará longe de suas atividades por um mês.

O Gestor de Segurança da Informação sabe que este colaborador detêm de uma credencial de altos privilégios para executar as atividades de backup e entende que mesmo durante sua ausência o backup precisa continuar a ser gerenciado e monitorado.

Porém o que lhe preocupa é que será necessário entregar para outro colaborador a credencial com altos privilégios ou criar uma nova somente para outro executar as atividades de backup."

O que só expande a superfície de risco já que um usuário terá o poder, mesmo temporário de um credencial que não é a sua, e ao criar uma nova o número de credenciais privilegiadas para serem exploradas aumenta." Neste caso as atividades de backup podem ser criadas no Task Manager e serem executadas por um outro colaborador que não terá conhecimento das credenciais ou acesso ao dispositivo onde as atividades serão executadas.

Ainda com este cenário em mente as seções a seguir apresentaram como cadastrar e executar uma task neste contexto. Acesse o relatório de tasks através do menu Task Manager ➔ Tasks para reproduzir as instruções das seções.

Cadastrando uma task​

  1. Clique no botão Exibir ações do relatório

  2. Clique na opção Nova

    info

    Você também pode utilizar o botão Ações rápidas e selecionar a opção Task e o formulário de cadastro será aberto automaticamente.

    Formulário de cadastro de task

  3. Insira o nome desta task no campo Nome de identificação da task como na figura cadastrotask-ptbr

    info

    Escolha um nome que remeta ao objetivo do task para que seja fácil encontra-la sempre que houver necessidade. Ex: Reiniciar serviços de backup

  4. Selecione o Ambiente e Sistema desta task

  5. No campo Selecione o template a ser usado escolha o template criado anteriormente.

    caution

    Lembre-se que o template escolhido é um conjunto de comandos que serão executados para a task, ou seja, se sua task tem objetivo de "Reiniciar os serviços de backup", porém o template escolhido contém comandos para troca de senha o senhasegura respeitará o template escolhido e executará os comandos descritos nele.

  6. Na divisão seguinte Variáveis para execução será possível inserir um valor para variável presente no template, como mencionamos na seção Cadastrando um template.

    As variáveis nos permitem utilizar o mesmo template em mais de uma task, por exemplo, observe este trecho do template exemplo:

    #Reinicia o serviço
        expect "*#"
        exec "service [#VARIAVEL#] restart"

    Em nossa task atual precisamos reiniciar os serviços de backup por isto vamos definir o valor da variável [#VARIAVEL#] como rsync igual na figura variavel-ptbr.

    Formulário de cadastro de task - campo de variável

    Caso precise reiniciar os serviços de MySQL posso criar uma outra task com o mesmo template apenas definindo o valor da variável para mysql.

    info

    Quando utilizar as variáveis no template as descreva desta maneira: [#NOME_VARIAVEL#]

    • Entre colchetes ([ ])

    • Com cerquilha (#)

    • Em maiúsculo

    No formulário da task a variável deve ser digitada sem os colchetes e a cerquilha, podendo ou não estar em maiúsculo.

    Se não desejar utilizar uma variável, apenas insira todos os comandos desejados no template, sempre levando em consideração que o senhasegura respeita os comandos inseridos nele.

  7. Selecione a credencial para execução:

    • Utilizar uma credencial cadastrada: Selecione esta caixa se desejar utilizar uma das credenciais cadastradas no senhasegura para se autenticar no dispositivo onde a task será executada

    • Username da credencial: Preencha o username da credencial que deseja que se autentique no dispositivo onde a task será executada

  8. Siga para a próxima guia Dispositivos para execução e clique no botão Adicionar e selecione os dispositivos onde a task será executada como na figura cadastrotaskdisp-ptbr

  9. Em seguida clique em Adicionar selecionados.

    Caso tenha selecionado um dispositivo por engano clique no botão Remover e do mesmo modo selecione os dispositivos que deseja remover.

    Formulário de cadastro de task - adição de dispositivos

  10. Para finalizar clique em Salvar.

Executando uma task​

Após criar a task atualize o relatório para que ela seja exibida e siga as instruções:

  1. Encontre a task que deseja executar e clique no botão de ação respectivo e selecione a opção Executar tarefa. Você pode utilizar o filtro no topo do relatório caso tenha dificuldade para encontrar sua task criada.

  2. Selecione o motivo para execução, já cadastrado anteriormente.

    Se você pertence a um grupo de acesso que exige justificativa o campo texto Motivo como mostra na figura executartask-ptbr, deverá ser preenchido com uma descrição mais detalhada do porque você deseja que esta task seja executada.

    Formulário de justificativa de execução de task

  3. Após preencher o formulário clique em Executar tarefa

A partir deste momento a task já estará sendo executada no dispositivo destino.

Agendando uma task​

Você também pode realizar o agendamento da execução da task, para isso siga as instruções:

  1. Ainda no relatório de tasks e encontre aquela que deseja que seja agendada.

    Você pode utilizar o filtro no topo do relatório caso tenha dificuldade para encontrar sua task criada.

  2. Clique no botão de ação respectivo e selecione a opção Agendamentos.

  3. No rodapé da página clique em Agendar execução

  4. Selecione o Motivo para execução, já cadastrado anteriormente.

    Formulário para agendamento de task

  5. Descreva uma Justificativa detalhada para a razão de querer este agendamento

  6. Na divisão seguinte Dias para execução marque as caixas com os dias que deseja que a task seja executada.

  7. Em Períodos para execução marque as caixas correspondente ao horário que desejada que a task seja executada.

  8. Em seguida escolha o intervalo de tempo entre uma execução e outra, em horas

  9. Após definir esses detalhes clique em Salvar.

    Com isso a task já estará agendada para ser executada no dia e hora escolhidos. Caso deseje cancelar este agendamento:

    1. No relatório de agendamento clique no botão de ação Cancelar agendamento.

Verificar a execução​

Para verificar se a execução foi realizada com sucesso siga as instruções:

  1. Siga para o relatório de operações através do menu Task Manager ➔ Operações

    Relatório de operação das tasks

  2. O relatório exibirá todas as tasks executadas, agendadas ou em execução. Os possíveis status são:

    • Agendada: A task ainda não foi executada e só será no dia e hora marcados em seu agendamento.

    • Em execução: No momento da abertura deste relatório a task ainda está sendo executada no dispositivo destino. Aguarde alguns instantes e recarregue a página para visualizar o seu status após a conclusão.

    • Efetuada com sucesso: A execução foi concluída sem nenhum erro.

    • Erro: Houve algum erro durante a execução da task e esta não foi concluída.

    • Cancelada: Em algum momento antes ou durante a execução um usuário solicitou o cancelamento da task e esta não foi concluída.

    • Aguardando aprovação: O usuário que solicitou a execução da task é membro de um grupo que necessita de aprovação para que suas solicitações sejam executadas. A task fica em modo de espera até que um aprovador do grupo permita a sua execução.

    • Expirada: A aprovação para execução da task levou muito tempo e seu tempo para operação expirou.

    Utilize a barra de filtros do formulário para encontrar a task desejada rapidamente. Se sua task, como na figura operacoes-ptbr, estiver na cor:

    • Verde: foi executada com sucesso.

    • Vermelha: ocorreu algum erro na execução.

  3. Clique no botão de ação para confirer os Logs de execução para entender como a operação foi executada e os problemas em caso de erros.

    Log da operação da task

Você também poderá realizar posteriormente a verificação em seu próprio dispositivo das tasks executadas. % Redefinindo a pasta atual do capitulo

Conclusão​

Ao finalizar esse livro você terá adquirido conhecimento para realizar a execução e o agendamento de tarefas através do senhasegura .

Se deseja continuar aprendendo como utilizar o sistema da melhor forma possível solicite ao nosso time de suporte nossa documentação disponível de acordo com o seu perfil e necessidade:

Manuais​

  • Manual do Usuário

  • Manual do Administrador da Ferramenta

  • Manual do Administrador de Operações

  • Manual do Auditor

  • Manual do Desenvolvedor

  • Manual DevSecOps

  • Manual de Monitoramento

  • Manual Cloud IAM

  • Manual Orbit CLI

Cookbooks​

  • Primeira Experiência Cookbook

  • Troca de Senha Cookbook

Outros​

  • Especificação Técnica

  • Guia de Monitoramento

  1. Caso ainda não saiba como cadastrar dispositivos e configurar portas de acesso consulte o Cookbook Primeira Experiência.↩
  2. Caso ainda não saiba como cadastrar credenciais e configurar seus acessos consulte Cookbook Primeira Experiência.↩
  3. Este cookbook tem como objetivo tratar apenas do assunto Task Manager os demais tipos de execuções presentes nesta caixa serão abordados em outras documentações, consulte nosso time de suporte a respeito.↩