j7mbo/silex-auth-skeleton

Silex skeleton with already integrated login, mysql auth (doctrine), firewalls, routing, config files and auryn DiC.

dev-master 2015-04-19 13:33 UTC

Requires

• dflydev/doctrine-orm-service-provider: 1.0.*@dev
• entea/silex-twig-simple-asset-extension: dev-master
• ircmaxell/password-compat: dev-master
• monolog/monolog: 1.6.*@dev
• rdlowrey/auryn: dev-v1.0.0-dev
• silex/silex: 1.1.*
• symfony/security: 2.3.*
• symfony/twig-bridge: 2.3.*
• symfony/yaml: 2.4.*@dev
• twig/twig: >=1.8,<2.0-dev

WTFPL (Do What The Fuck You Want To Public License)

• James Mallison

• silex
• mysql
• auth
• Skeleton

README

Annoyed with having to figure out the best code and directory structure for a working Silex skeleton? Well, look no further. This code is a great baseline for all your needs.

Update (19/04/2015): Keep an eye on the new Aurex project which will replace silex-auth-skeleton. It's faster, nicer and uses the latest Silex (2.x) and Symfony 2 components (2.7.*).

Features

• Configuration loaded from YAML files, just like in Symfony2
• Environment specific config file (dev/live), routes config file, firewall file
• Login form using MySQL authentication (username or email) and a SHA1 password requirement
• Twig set up and ready to go for your templates
• Awesome autowiring DiC Auryn for auto object instantiation / wiring
• Working firewall - currently, anonymous users can visit / and /login. Everything else is secured!
• BCrypt password authentication via ircmaxell's password_compat library
• Doctrine ORM Integration with Entity / Repositories / Command-Line (the awesome stuff that Symfony has)
• Code is in controllers, with requests routed to these automatically
• Nicely laid out PSR compliant code

Installation

You can clone this repo to get the code directly:

$ git clone git://github.com/j7mbo/silex-auth-skeleton.git

Once you have the code, you'll need to use composer to update your dependencies:

$ cd silex-auth-skeleton/
$ composer update

You will need the following database table:

+----------+------------------+------+-----+---------+----------------+
| Field    | Type             | Null | Key | Default | Extra          |
+----------+------------------+------+-----+---------+----------------+
| id       | int(11) unsigned | NO   | PRI | NULL    | auto_increment |
| username | varchar(100)     | NO   | UNI |         |                |
| email    | varchar(100)     | NO   | UNI | NULL    |                |
| password | varchar(255)     | NO   |     |         |                |
| roles    | varchar(255)     | NO   |     |         |                |
| is_active| tinyint(1)       | NO   |     | 0       |                |
+----------+------------------+------+-----+---------+----------------+

SQL statement to create the above database and table:

mysql> CREATE DATABASE `silexauth`;
mysql> CREATE TABLE `users` (
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
    `username` varchar(100) NOT NULL DEFAULT '',
    `email` varchar(100) NOT NULL,
    `password` varchar(255) NOT NULL DEFAULT '',
    `roles` varchar(255) NOT NULL DEFAULT '',
    `is_active` tinyint(1) NOT NULL,
    PRIMARY KEY (`id`),
    UNIQUE KEY `unique_email` (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

You'll also need a test user:

mysql> INSERT INTO `users` (username, email, password, roles) VALUES (
    'test', '[e-mail]', '$2y$10$k5O1HnSI8N0ORJQnMnFpR.Z0.r7nx4Epk0a8J3d/sCdATF0BStBKe', 'ROLE_USER', '1'
);

You'll also need a host / vhost to route everything through.

Add "127.0.0.1 silex-auth.local" (no quotes) to your /etc/hosts file.

Run the following commands to create a vhost file for silex-auth.local.

$ cd /etc/apache2/sites-available
$ sudo nano silex-auth.local

Copy / paste the following into your silex-auth.local file:

<VirtualHost *:80>
    ServerName silex-auth.local
    ServerAlias silex-auth.local

    DocumentRoot "/home/james/Dev/github/silex-auth/web/"
    DirectoryIndex index.php

    <Directory "/home/james/Dev/github/silex-auth/web/">
        AllowOverride All
        Allow from All
    </Directory>
</VirtualHost>

Now save it, enable the vhost, and restart apache so that everything loads properly.

$ ctrl + x, then y, then enter
$ sudo a2ensite silex-auth.local
$ sudo service apache2 restart

Importantly, you also need a .htaccess file in the silx-auth root directory (not /web), containing:

FallbackResource /index.php

You should now be able to point at http://silex-auth.local in your browser and see the home page. After clicking the login link, you should be able to login with either "test" and "password", or "[e-mail]" and "password".