Skip to content

Correct ssl behaviour #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rahulsprajapati merged 11 commits into from
Aug 22, 2018
Merged

Correct ssl behaviour #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
367c6fa
Correct --ssl flag behaviour
kirtangajjar Aug 14, 2018
83cffb5
Add error on incorrect --ssl param value
kirtangajjar Aug 14, 2018
4f6fa35
Correct redirect block placement
kirtangajjar Aug 17, 2018
7194812
Correct case of SiteUtils namespace
kirtangajjar Aug 21, 2018
5f4ae99
Correct SSL and site redirection logic.
kirtangajjar Aug 21, 2018
92fc974
Add inherit argument
kirtangajjar Aug 21, 2018
7e91597
Merge remote-tracking branch 'origin/develop' into ssl-wildcard-all-s…
kirtangajjar Aug 21, 2018
c5eb301
Replace site['name'] with site['url']
kirtangajjar Aug 21, 2018
9a6081d
Remove site_command
kirtangajjar Aug 21, 2018
5e14dea
Correct ssl flag
kirtangajjar Aug 21, 2018
04899d5
Add le-email in config
kirtangajjar Aug 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions features/bootstrap/FeatureContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ public function __construct()
{
$this->commands = [];
$this->ee_path = getcwd();
$config_contents = \Mustangostang\Spyc::YAMLDump(['le-mail' => 'abc@example.com']);
file_put_contents( EE_CONF_ROOT . '/config.yml', $config_contents );
}

/**
Expand Down
4 changes: 2 additions & 2 deletions features/redirect.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Feature: Site Redirection
| Location: http://www.example1.test/ |

Scenario: no_www-ssl redirection works properly
When I run 'sudo bin/ee site create example2.test --le --le-mail=test@test.com --skip-status-check'
When I run 'sudo bin/ee site create example2.test --ssl=le --skip-status-check'
Then After delay of 5 seconds
Then Request on 'localhost' with header 'Host: www.example2.test' should contain following headers:
| header |
Expand All @@ -29,7 +29,7 @@ Feature: Site Redirection
| Location: https://example2.test/ |

Scenario: www-ssl redirection works properly
When I run 'sudo bin/ee site create www.example3.test --le --le-mail=test@test.com --skip-status-check'
When I run 'sudo bin/ee site create www.example3.test --ssl=le --skip-status-check'
Then After delay of 5 seconds
Then Request on 'localhost' with header 'Host: example3.test' should contain following headers:
| header |
Expand Down
78 changes: 53 additions & 25 deletions src/Site_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,14 @@ class Site_Command extends EE_Site_Command {
private $logger;

/**
* @var bool $le Whether the site is letsencrypt or not.
* @var bool $ssl Whether the site is has SSL enabled.
*/
private $le;
private $ssl;

/**
* @var bool $ssl_wildcard Whether the site SSL is wildcard.
*/
private $ssl_wildcard;

/**
* @var bool $skip_chk To skip site status check pre-installation.
Expand Down Expand Up @@ -75,9 +80,11 @@ public function __construct() {
* <site-name>
* : Name of website.
*
* [--letsencrypt]
* [--ssl=<value>]
* : Enables ssl via letsencrypt certificate.
*
* [--wildcard]
* : Gets wildcard SSL .
* [--type=<type>]
* : Type of the site to be created. Values: html,php,wp.
*
Expand All @@ -100,8 +107,9 @@ public function create( $args, $assoc_args ) {
EE::error( sprintf( "Site %1\$s already exists. If you want to re-create it please delete the older one using:\n`ee site delete %1\$s`", $this->site['url'] ) );
}

$this->le = EE\Utils\get_flag_value( $assoc_args, 'letsencrypt' );
$this->skip_chk = EE\Utils\get_flag_value( $assoc_args, 'skip-status-check' );
$this->ssl = EE\Utils\get_flag_value( $assoc_args, 'ssl' );
$this->ssl_wildcard = EE\Utils\get_flag_value( $assoc_args, 'wildcard' );
$this->skip_chk = EE\Utils\get_flag_value( $assoc_args, 'skip-status-check' );

EE\SiteUtils\init_checks();

Expand All @@ -124,14 +132,18 @@ public function info( $args, $assoc_args ) {
$args = EE\SiteUtils\auto_site_name( $args, 'site', __FUNCTION__ );
$this->populate_site_info( $args );
}
$ssl = $this->le ? 'Enabled' : 'Not Enabled';
$prefix = ( $this->le ) ? 'https://' : 'http://';
$ssl = $this->ssl ? 'Enabled' : 'Not Enabled';
$prefix = ( $this->ssl ) ? 'https://' : 'http://';
$info = [
[ 'Site', $prefix . $this->site['url'] ],
[ 'Site Root', $this->site['root'] ],
[ 'SSL', $ssl ],
];

if ( $this->ssl ) {
$info[] = [ 'SSL Wildcard', $this->ssl_wildcard ? 'Yes': 'No' ];
}

EE\Utils\format_table( $info );

EE\Utils\delem_log( 'site info end' );
Expand All @@ -155,7 +167,6 @@ private function configure_site_files() {

$filter = [];
$filter[] = $this->site['type'];
$filter[] = $this->le;
$site_docker = new Site_Docker();
$docker_compose_content = $site_docker->generate_docker_compose_yml( $filter );
$default_conf_content = $default_conf_content = EE\Utils\mustache_render( SITE_TEMPLATE_ROOT . '/config/nginx/default.conf.mustache', [ 'server_name' => $this->site['url'] ] );
Expand All @@ -182,8 +193,6 @@ private function configure_site_files() {
$this->fs->mkdir( $site_src_dir );
$this->fs->dumpFile( $site_src_dir . '/index.html', $index_html );

EE\Siteutils\add_site_redirects( $this->site['url'], $this->le );

EE::success( 'Configuration files copied.' );
} catch ( Exception $e ) {
$this->catch_clean( $e );
Expand All @@ -198,26 +207,42 @@ private function create_site() {
$this->site['root'] = WEBROOT . $this->site['url'];
$this->level = 1;
try {
EE\Siteutils\create_site_root( $this->site['root'], $this->site['url'] );
EE\SiteUtils\create_site_root( $this->site['root'], $this->site['url'] );
$this->level = 2;
EE\Siteutils\setup_site_network( $this->site['url'] );
EE\SiteUtils\setup_site_network( $this->site['url'] );
$this->level = 3;
$this->configure_site_files();

EE\Siteutils\start_site_containers( $this->site['root'] );
EE\SiteUtils\start_site_containers( $this->site['root'] );

EE\Siteutils\create_etc_hosts_entry( $this->site['url'] );
EE\SiteUtils\create_etc_hosts_entry( $this->site['url'] );
if ( ! $this->skip_chk ) {
$this->level = 4;
EE\Siteutils\site_status_check( $this->site['url'] );
EE\SiteUtils\site_status_check( $this->site['url'] );
}

/*
* This adds http www redirection which is needed for issuing cert for a site.
* i.e. when you create example.com site, certs are issued for example.com and www.example.com
*
* We're issuing certs for both domains as it is needed in order to perform redirection of
* https://www.example.com -> https://example.com
*
* We add redirection config two times in case of ssl as we need http redirection
* when certs are being requested and http+https redirection after we have certs.
*/
EE\SiteUtils\add_site_redirects( $this->site['url'], false, 'inherit' === $this->ssl );
EE\SiteUtils\reload_proxy_configuration();

if ( $this->ssl ) {
$this->init_ssl( $this->site['url'], $this->site['root'], $this->ssl, $this->ssl_wildcard );
EE\SiteUtils\add_site_redirects( $this->site['url'], true, 'inherit' === $this->ssl );
EE\SiteUtils\reload_proxy_configuration();
}
} catch ( Exception $e ) {
$this->catch_clean( $e );
}

if ( $this->le ) {
$this->init_le( $this->site['url'], $this->site['root'], false );
}
$this->info( [ $this->site['url'] ], [] );
$this->create_site_db_entry();
}
Expand All @@ -227,13 +252,16 @@ private function create_site() {
*/
private function create_site_db_entry() {

$ssl = $this->le ? 'letsencrypt' : null;
$ssl = $this->ssl ? 1 : 0;
$ssl_wildcard = $this->ssl_wildcard ? 1 : 0;

$site = Site::create([
'site_url' => $this->site['url'],
'site_type' => $this->site['type'],
'site_fs_path' => $this->site['root'],
'site_ssl' => $ssl,
'site_url' => $this->site['url'],
'site_type' => $this->site['type'],
'site_fs_path' => $this->site['root'],
'site_ssl' => $ssl,
'site_ssl_wildcard' => $ssl_wildcard,
'created_on' => date( 'Y-m-d H:i:s', time() ),
]);

try {
Expand All @@ -259,8 +287,8 @@ private function populate_site_info( $args ) {
if ( $site ) {
$this->site['type'] = $site->site_type;
$this->site['root'] = $site->site_fs_path;
$this->le = $site->site_ssl;

$this->ssl = $site->site_ssl;
$this->ssl_wildcard = $site->site_ssl_wildcard;
} else {
EE::error( sprintf( 'Site %s does not exist.', $this->site['url'] ) );
}
Expand Down