readme.es.md

English

Gestor de Contraseñas

Esta aplicación permite una gestión completa de contraseñas para múltiples tipos de servicios (web, ssh, teléfonos, wifi, etc...).

Los datos de cada aplicación se guardan cifrados en base de datos.

El cifrado de estos datos se realiza usando el valor de APP_KEY como salt, con lo cual es importantísimo no regenerar esta key o perderás el acceso a todas las aplicaciones registradas.

Ni se te ocurra instalar este proyecto en un entorno sin protección HTTPS

Las características principales son:

• Gestión de usuarios.
• Gestión de equipos.
• Acceso a aplicaciones limitadas por equipos.
• Múltiples tipos de datos a registrar.
• Cifrado en base de datos.
• Autenticación por certificado y doble factor con Google Authenticator.
• Usando certificado puedes desactivar el acceso por contraseña.
• Dispone de un log que registra cada vez que algún usuario accede, consulta o actualiza una aplicación.
• Permite aplicaciones privadas o compartidas.
• Limitación de acceso por país.
• Dispone de una extensión de chrome que se conecta vía API y accede directamenete a las credenciales de la web que estás visitando.
• Solicitud de contraseña de API cada vez que se accede desde una IP diferente.

Este proyecto dispone de una extensión para Google Chrome que puedes descargar en https://github.com/eusonlito/Password-Manager-Chrome

Requisitos

• Apache2 (nginx no soporta autenticación con certificado limitado a ciertas rutas)
• PHP 8.1 o superior (php-curl php-imagick php-mbstring php-mysql php-zip)
• MySQL 8.0
• ImageMagick

Si la versión por defecto de tu servidor es inferior a PHP 8.1 siempre debes usar el prefijo de versión, tanto para composer como para artisan, por ejemplo:

php8.1 ./composer install --no-dev --optimize-autoloader --classmap-authoritative --ansi

php8.1 artisan key:generate

Instalación Local

1. Creamos la base de datos en MySQL.

2. Clonamos el repositorio.

git clone https://github.com/eusonlito/Password-Manager.git

3. Copia el fichero .env.example como .env y rellena las variables necesarias.

cp .env.example .env

4. Realizamos la primera instalación (recuerda que siempre usando el binario de PHP 8.1).

./composer install --no-dev --optimize-autoloader --classmap-authoritative --ansi

5. Generamos la clave de aplicación. Recuerda guardar una copia de seguridad de esta clave (.env > APP_KEY).

php artisan key:generate

6. Regeneramos las cachés.

./composer artisan-cache

7. Lanzamos la migración inicial.

php artisan migrate

8. Lanzamos el seeder.

php artisan db:seed --class=Database\\Seeders\\Database

9. Configuramos la tarea cron para el usuario relacionado con el proyecto:

* * * * * cd /var/www/password.domain.com && php artisan schedule:run >> storage/logs/artisan-schedule-run.log 2>&1

10. Creamos el usuario principal.

php artisan user:create --email=user@domain.com --name=Admin --password=StrongPassword2 --admin

11. Configuramos el servidor para acceso web con DOCUMENT_ROOT en public.

12. Profit!

Actualización

La actualización de la plataforma se puede realizar de manera sencilla con el comando composer deploy ejecutado por el usuario que gestiona ese projecto (normalmente www-data).

Instalación vía Docker

Actualmente debería ser usado únicamente para testing (no soporta autenticación con certificado).

1. Clonamos el repositorio.

git clone https://github.com/eusonlito/Password-Manager.git

2. [OPCIONAL] Copia el fichero docker/.env.example en .env y configura tus propios ajustes

cp docker/.env.example .env

3. [OPCIONAL] Copia el fichero docker/docker-compose.yml.example en docker/docker-compose.yml y configura tus propios ajustes

cp docker/docker-compose.yml.example docker/docker-compose.yml

4. Realizamos el build (pedirá la contraseña de sudo)

./docker/build.sh

5. Iniciamos los contenedores (pedirá la contraseña de sudo)

./docker/run.sh

6. Creamos el usuario principal (pedirá la contraseña de sudo)

./docker/user.sh

7. Ya podemos acceder desde http://localhost:8080

8. Recuerda añadir un servidor web (apache2, nginx, etc...) como proxy para añadir funcionalidades como SSL.

Actualización

1. Actualizamos el código del proyecto

git pull

2. Realizamos el build (pedirá la contraseña de sudo)

./docker/build.sh

3. Iniciamos los contenedores (pedirá la contraseña de sudo)

./docker/run.sh

4. Ya podemos acceder desde http://localhost:8080

Autenticación con Certificado

Para poder realizar la autenticación con certificado debemos añadir la siguiente configuración en el VirtualHost de Apache:

<Location /user/profile/certificate>
        SSLVerifyClient require
        SSLVerifyDepth 2
        SSLOptions +StdEnvVars +ExportCertData +OptRenegotiate
</Location>

<Location /user/auth/certificate>
        SSLVerifyClient require
        SSLVerifyDepth 2
        SSLOptions +StdEnvVars +ExportCertData +OptRenegotiate
</Location>

SSLCACertificateFile /var/www/password.domain.com/resources/certificates/certificates.pem

La localización /user/profile/certificate permite obtener el identificador del certificado automáticamente desde el propio perfil de usuario, y /user/auth/certificate es la ruta de autenticación por certificado.

La opción de OptRenegotiate le permite a Apache renegociar la conexión de manera independiente por ruta, algo que nginx no soporta.

Comandos

Alta de usuario:

php artisan user:create {--email=} {--name=} {--password=} {--admin} {--readonly} {--teams=}

Actualización de usuario:

php artisan user:update {--id=} {--email=} {--name=} {--password=} {--certificate=} {--tfa_enabled=} {--admin=} {--readonly=} {--enabled=} {--teams=}

Ayuda!

Pues estaría guay un poco de ayuda para mejorar la traducción a inglés en resources/lang/en, así como el readme.en.md.

Capturas