Commit 9b02d616 authored by root's avatar root
Browse files

Initial commit

Errors faced during installation/configuration
First, read the instructions at !
* Some python libraries where missing from the 'as is' Ubuntu 13.10 install and had to be installed:
sudo apt-get install python-dev
sudo apt-get install libldap2-dev
sudo apt-get install libsasl2-dev
sudo apt-get install python-ldap
sudo apt-get install gettext # to compile messages
sudo apt-get install libapache2-mod-wsgi # if using apache
pip install uwsgi
* Helios original settings file come with
apps commented out.
When I've tried to login using ldap user and password, I've got the following error:
DatabaseError: relation "auth_user" does not exist
LINE 1: ...ser"."last_login", "auth_user"."date_joined" FROM "auth_user...
Exception Type: DatabaseError
Exception Value:
current transaction is aborted, commands ignored until end of transaction block
Enabling those apps solved the problem.
* Vote hash was not saving
Everything was working fine, except that the vote hash wasn't being saved. This was happening because I didn't started the background job processor (issue kindly answered by Ben Adida)
Run the following command in a separate terminal window:
python celeryd
Dont' forget to install rabbitmq (
sudo apt-get install rabbitmq-server
* module' object has no attribute 'STATUS_UPDATES
Your auth model needs to declare STATUS_UPDATES
\ No newline at end of file
Helios is an open-source project.
Significant contributors:
- Ben Adida
- Olivier Pereira
- Olivier de Marneffe
- Emily Stark, Mike Hamburg, Tom Wu, and Dan Boneh for SJCL and integration of javascript crypto.
- Nicholas Chang-Fong and Aleksander Essex for security reports and fixes.
- Shirley Chaves
- Marco Ciotola
* install PostgreSQL 8.3+
* make sure you have virtualenv installed:
* download helios-server
* cd into the helios-server directory
* create a virtualenv:
virtualenv venv
* activate virtual environment
source venv/bin/activate
* install requirements
pip install -r requirements.txt
* reset database
* start server
python runserver
* to get Google Auth working:
** go to
** create an application
** set up oauth2 credentials as a web application, with your origin, e.g., and your auth callback, which, based on our example, is
** still in the developer console, enable the Google+ API.
** set the GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET configuration variables accordingly.
\ No newline at end of file
Apache License
Version 2.0, January 2004
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
implied, including, without limitation, any warranties or conditions
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
docker-compose -f docker/compose.yml --project-directory . build
compose-up: compose-build
docker-compose -f docker/compose.yml --project-directory . up -d
compose-start: compose-build
docker-compose -f docker/compose.yml --project-directory . start
docker-compose -f docker/compose.yml --project-directory . stop
compose-rm: compose-stop
docker-compose -f docker/compose.yml --project-directory . rm
docker-compose -f docker/compose.yml --project-directory . logs
docker build -t .
local-k8s: dev-docker-image
eval $(minikube docker-env)
kubectl create namespace helios || true
helm dependency build ci/helios-server || helm dependency update ci/helios-server
helm upgrade -n helios -i helios-server --set --set image.tag=latest ci/helios-server
kubectl rollout status deployment -n helios helios-server
web: gunicorn wsgi:application -b$PORT -w 8
worker: celery worker --app helios --events --beat --concurrency 1 --logfile celeryw.log --pidfile
\ No newline at end of file
This diff is collapsed.
# Setting this variable will affect all Security templates
# (SAST, Dependency Scanning, ...)
stage: test
# By default, use the latest clair vulnerabilities database, however, allow it to be overridden here with a specific image
# to enable container scanning to run offline, or to provide a consistent list of vulnerabilities for integration testing purposes
# Override the GIT_STRATEGY variable in your `.gitlab-ci.yml` file and set it to `fetch` if you want to provide a `clair-whitelist.yml`
# file. See
# for details
allow_failure: true
alias: clair-vulnerabilities-db
- /analyzer run
container_scanning: gl-container-scanning-report.json
dependencies: []
when: never
$GITLAB_FEATURES =~ /\bcontainer_scanning\b/
# Personalização dos manuais de ajuda do Helios
Esse manual de ajuda foi feito com [MkDocs]( e com o tema [Material for MkDocs](
Caso deseje alterar o texto do manual, basta editar os arquivos presentes no diretório [docs](docs/).
Após as alterações será necessário compilar, fazendo uso do comando `mkdocs build`.
Os arquivos resultantes da compilação serão armazenados no diretório `site`. Mova esses arquivos para dentro do diretório que está mapeando no Apache para hospedar a página de ajuda.
\ No newline at end of file
# Como iniciar uma eleição
## Congelando cédula e abrindo eleição
1. Acesse o endereço [](, clique no menu **Conectar** e forneça seu nome de usuário e senha.
2. Na lista que aparece no lado direito da tela, clique no link da eleição que deseja iniciar
3. Na página inicial da eleição, clique no *link* **congelar cédula e abrir eleição**.
- **[Se ao criar a eleição](** você especificou uma data e horário para o campo **Votação começa em**, então a **eleição será aberta automaticamente somente após** a data e horário especificado.
- **[Se ao criar a eleição](** você não especificou uma data e horário para o campo **Votação começa em**, então a **eleição será aberta imediatamente**.
![Congelando cédula e abrindo eleição](img/helios-congelar-inicial.png "Congelando cédula e abrindo eleição")
4. Se estiver certo que deseja abrir a eleição, clique no botão **Congelar a cédula**.
- **Atenção:** Após congelar a cédula não será possível alterar qualquer informação sobre a eleição, o que inclui suas questões, respostas, apuradores, etc.
![Congelando cédula e abrindo eleição](img/helios-congelar.png "Congelando cédula e abrindo eleição")
## Disparando e-mail com as credenciais para os eleitores
Cada eleitor precisa receber por e-mail suas credenciais (*login* e senha) exclusivas para votar na referida eleição. É possível enviar e-mails em massa, ou seja, para todos os eleitores cadastrados, ou ainda, é possível enviar e-mail para um eleitor específico.
1. Na página inicial da eleição clique no botão **Eleitores & cédulas**.
- **Se deseja enviar e-mail em massa** (para todos eleitores cadastrados), clique no botão **Enviar e-mail para eleitores**.
- **Se deseja enviar e-mail para um eleitor em específico**, então clique no ícone do envelope azul que esteja na linha com o nome do eleitor para quem deseja enviar e-mail.
- **Se deseja adicionar novos eleitores**, então clique no botão **Carregar arquivo de eleitores**.
- **Se deseja remover um eleitor em específico**, então clique no ícone de um X azul que esteja na linha com o nome do eleitor que deseja excluir.
![Enviar e-mail para eleitores](img/helios-enviar-email.png)
2. Escolha o tipo de e-mail **Hora de votar**
3. No campo **Assunto** informe o assunto do e-mail, por exemplo, "Eleição para escolha do conselho 2018 está aberta para votação"
- Opcionalmente, no campo **Corpo**, é possível incluir uma mensagem que aparecer no corpo do e-mail.
4. Na caixa de seleção **Enviar Para** é possível escolher se deseja enviar para:
- **Todos os eleitores registrados**; ou
- **Somente para os eleitores que já depositaram uma cédula**; ou
- **Somente para os eleitores que não depositaram qualquer cédula**; ou ainda
- **Envio contingenciado** - somente para os eleitores que ainda não receberam e-mail (**X/Y**)
- **ATENÇÃO:** Só use essa opção após consultar a equipe técnica de TI
- Essa opção permite o envio de pequenos lotes de e-mail, cujo tamanho foi definido em tempo de implantação (por padrão 1.000). Toda vez que essa opção for escolhida, serão enviados e-mails para os próximos 1.000 eleitores da lista.
- O **valor X** indica o total de eleitores que já recebeu e-mail desse modelo (tipo de e-mail).
- O **valor Y** indica o total de eleitores registrados para a eleição.
- **Atenção:** O administrador da eleição é o único responsável por garantir que todos os eleitores de uma eleição receberam o e-mail. Ou seja, o valor de **X** deverá ser igual ao valor de **Y**.
5. Clique no botão **Enviar**.
6. Pronto! Você será redirecionado para a página inicial da eleição.
![Enviando e-mail para eleitores](img/helios-email-hora-votar.png)
Ao ser designada como um Apurador, a pessoa receberá um e mail do Sistema de Votação Helios com as instrução e um *link* para que essa possa gerar ou carregar sua chave privada. A pessoa deve obrigatoriamente entrar no *link* que está no e-mail para que possa carregar suas informações de apurador.
**ATENÇÃO:** O apurador deve manter esse e-mail, pois a URL contida nele deverá ser usada novamente para que se possa apurar a eleição.
1. Após clicar no *link* que recebeu por e-mail, clique no botão configurar **chave de apurador**.
2. Clique no botão **Gerar Chaves da Eleição**.
3. Clique no botão **Salve sua chave privada**. Será aberta uma nova aba no navegador com uma sequência numérica grande. Clique no meu arquivo do navegador e escolha a opção **Salvar**.
- Escolha o local onde o arquivo será salvo e coloque o nome que desejar para o arquivo, mas deixe a extensão como txt. Por exemplo, **minha-chave-privada.txt**. Clique no botão salvar e pode fechar essa janela ou aba.
- Salve esse arquivo em um local seguro, pois ele será necessário no momento da apuração.
4. Clique no *link* **ok, a chave foi salva, vamos prosseguir**.
5. Por fim, clique no botão **Carregar sua chave pública**.
6. Parabéns, você carregou a chave com sucesso! Se desejar, você pode fazer um teste a fim de verificar se possui a chave privada correta, basta clicar no botão **verificar se você tem a chave privada correta**. Esse passo é opcional.
\ No newline at end of file
1. Abra o e-mail que recebeu quando foi designado como apurador e clique no endereço *link* contido neste.
2. Clique no **botão decifrar com sua chave**.
3. Abra o arquivo onde você salvou sua chave criptográfica (usando por exemplo o aplicativo bloco de notas), copie toda a sequência de caracteres e cole na área de texto em branco da figura abaixo
4. Clique no botão **Gerar minha parte da desencriptação**.
5. Clique no botão **Carregar fatores de desencriptação para o servidor**.
6. Pronto, você concluiu a sua parte da apuração desta eleição. Cabe agora ao administrador da eleição realizar o procedimento para computar e publicar o resultado da eleição.
\ No newline at end of file
# Como criar uma eleição
## Informações gerais
1. Acesse o endereço [](, clique no menu **Conectar** e forneça seu nome de usuário e senha.
2. Clique no botão **Criar eleição** e preencha o formulário conforme orientação abaixo:
| **Campo** | **Descrição** |
| --------------------------------------------- | ------------------------------------------------------------ |
| **Nome abreviado** | Nome que aparecerá na URL da eleição. Escolha um nome que faça sentido para eleição, contudo esse nome **NÃO PODE conter espaços**. |
| **Nome** | Nome que aparecerá em destaque para os eleitores. Escolha um nome que os eleitores possam facilmente identificar que eleição estão prestes a votar. Por exemplo: *Eleição do Conselho XYZ 2018* |
| **Descrição** | Pode colocar informações detalhadas sobre a eleição, por exemplo, alguns pontos cruciais do edital, regimento da eleição, etc. |
| **Usar pseudônimos de eleitores** | Se marcada, a identidade dos eleitores será substituída por pseudônimos, p. ex.: "V12", no centro de rastreamento de cédulas. **É altamente recomendado deixar ativado essa opção.** |
| **Usar funcionalidade avançada de auditoria** | Ao ativar essa opção, os eleitores terão acesso a funcionalidades que permitiriam auditar a eleição, contudo deixaria a interface um pouco mais complicada. **Recomenda-se deixar desativada essa opção**. |
| **Tornar ordem das questões aleatória** | Habilite essa opção se você quiser que as questões apareçam em ordem aleatória para cada eleitor |
| **Endereço de email para ajuda** | Informe um endereço de email que os eleitores devem usar caso precisem de alguma ajuda. |
| **Votação começa em** | A partir dessa data e horário os eleitores poderão depositar cédulas na urna. Contudo, ainda é necessário que o gestor abra a eleição (**[veja o manual](**). |
| **Votação termina em** | A partir dessa data e horário não será mais possível depositar cédulas na urna. |
3. Por fim, clique no botão **Próximo** e você verá a página incial da eleição, conforme figura abaixo:
![Página incial da eleição](img/helios-eleicao-view.png "Página inicial da eleição")
## Adicionando questões
Na página inicial da eleição clique no botão **Questões**. É possível adicionar quantas questões forem necessárias.
- **Uma eleição** é composta por uma ou mais questões.
- **Uma questão** é composta por uma ou mais respostas.
- É necessário que indique o **número mínimo e o número máximo de respostas** que o eleitor poderá escolher.
- Por padrão aparecem campos para 5 respostas. Você pode preencher menos que 5, contudo se precisar mais que 5, então clique no *link* **adicionar mais 5 respostas**.
- Cada resposta pode ter (opcional), além do texto principal, o endereço de uma página web externa.
- Nessa página poderia conter informações adcionais sobre a resposta. Por exemplo, essa página poderia conter uma mini biografia do candidato.
![Adicionando questões](img/helios-questao.png)
Ao terminar de criar as questões clique no *link* **[Voltar para a eleição]**, que se encontra no topo da página, para voltar para a página inicial da eleição.
## Carregando lista de eleitores
Na página inicial da eleição clique no botão **Eleitores & Cédulas**.
Só poderão votar em uma eleição os eleitores que forem carregados por meio de um arquivo CSV. Cada linha do arquivo do CSV representa um único eleitor e é composta pelos seguintes campos:
`login, endereço-de-email,Nome Completo`.
11122233344,,Eleitor Nonono
12345678900,,Segundo Nomomom
![Carregando lista de eleitores](img/helios-eleitores.png)
1. Clique no botão **carregar arquivo de eleitores**
2. Na próxima página clique no botão para procurar o arquivo CSV no disco do seu computador e por fim clique no botão **Carregar**.
3. Será apresentada uma prévia do arquivo que você está prestes a carregar. Se estiver correto, então clique no botão **Sim, carregar**. Se deseja carregar outro arquivo, então clique no botão **Não, deixe-me carregar um arquivo diferente**.
![Carregando eleitores de arquivo CSV](img/helios-eleitores-carregar.png)
**Atenção:** O tempo de processamento depende do tamanho do arquivo que fora carregado. Atualize a página (pressionando o botão "Atualizar" do teu navegador *web*) para verificar o progresso do processamento do arquivo.
Por fim, clique no link **voltar para a eleição** que está no topo da página. E se optar por deixar o sistema Helios como o único apurador, então vá para o manual **[Como iniciar uma eleição](** e ignore as seções abaixo.