2014-02-03 15:48:17 +04:00
/ *
* Copyright ( c ) 2014
*
* This file is licensed under the Affero General Public License version 3
* or later .
*
* See the COPYING - README file .
*
* /
( function ( ) {
OC . SetupChecks = {
2015-07-29 17:41:22 +03:00
/* Message types */
MESSAGE _TYPE _INFO : 0 ,
MESSAGE _TYPE _WARNING : 1 ,
MESSAGE _TYPE _ERROR : 2 ,
2014-02-03 15:48:17 +04:00
/ * *
* Check whether the WebDAV connection works .
*
* @ return $ . Deferred object resolved with an array of error messages
* /
checkWebDAV : function ( ) {
var deferred = $ . Deferred ( ) ;
var afterCall = function ( xhr ) {
var messages = [ ] ;
if ( xhr . status !== 207 && xhr . status !== 401 ) {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'Your web server is not yet set up properly to allow file synchronization because the WebDAV interface seems to be broken.' ) ,
type : OC . SetupChecks . MESSAGE _TYPE _ERROR
} ) ;
2014-02-03 15:48:17 +04:00
}
deferred . resolve ( messages ) ;
} ;
$ . ajax ( {
type : 'PROPFIND' ,
url : OC . linkToRemoteBase ( 'webdav' ) ,
data : '<?xml version="1.0"?>' +
'<d:propfind xmlns:d="DAV:">' +
'<d:prop><d:resourcetype/></d:prop>' +
'</d:propfind>' ,
complete : afterCall
} ) ;
return deferred . promise ( ) ;
} ,
2016-01-09 00:32:11 +03:00
/ * *
* Check whether the . well - known URLs works .
*
* @ param url the URL to test
* @ param placeholderUrl the placeholder URL - can be found at oc _defaults . docPlaceholderUrl
* @ return $ . Deferred object resolved with an array of error messages
* /
checkWellKnownUrl : function ( url , placeholderUrl ) {
var deferred = $ . Deferred ( ) ;
var afterCall = function ( xhr ) {
var messages = [ ] ;
if ( xhr . status !== 207 ) {
var docUrl = placeholderUrl . replace ( 'PLACEHOLDER' , 'admin-setup-well-known-URL' ) ;
messages . push ( {
msg : t ( 'core' , 'Your web server is not set up properly to resolve "{url}". Further information can be found in our <a target="_blank" href="{docLink}">documentation</a>.' , { docLink : docUrl , url : url } ) ,
type : OC . SetupChecks . MESSAGE _TYPE _ERROR
} ) ;
}
deferred . resolve ( messages ) ;
} ;
$ . ajax ( {
type : 'PROPFIND' ,
url : url ,
complete : afterCall
} ) ;
return deferred . promise ( ) ;
} ,
2014-02-03 15:48:17 +04:00
/ * *
* Runs setup checks on the server side
*
* @ return $ . Deferred object resolved with an array of error messages
* /
checkSetup : function ( ) {
var deferred = $ . Deferred ( ) ;
var afterCall = function ( data , statusText , xhr ) {
var messages = [ ] ;
if ( xhr . status === 200 && data ) {
2014-12-06 17:34:53 +03:00
if ( ! data . serverHasInternetConnection ) {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'This server has no working Internet connection. This means that some of the features like mounting external storage, notifications about updates or installation of third-party apps will not work. Accessing files remotely and sending of notification emails might not work, either. We suggest to enable Internet connection for this server if you want to have all features.' ) ,
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
2014-02-03 15:48:17 +04:00
}
2014-12-06 17:34:53 +03:00
if ( ! data . dataDirectoryProtected ) {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'Your data directory and your files are probably accessible from the Internet. The .htaccess file is not working. We strongly suggest that you configure your web server in a way that the data directory is no longer accessible or you move the data directory outside the web server document root.' ) ,
type : OC . SetupChecks . MESSAGE _TYPE _ERROR
} ) ;
2014-12-06 17:34:53 +03:00
}
2015-03-26 16:51:33 +03:00
if ( ! data . isMemcacheConfigured ) {
2015-07-29 17:41:22 +03:00
messages . push ( {
2015-12-21 21:28:32 +03:00
msg : t ( 'core' , 'No memory cache has been configured. To enhance your performance please configure a memcache if available. Further information can be found in our <a target="_blank" href="{docLink}">documentation</a>.' , { docLink : data . memcacheDocs } ) ,
2015-07-29 18:40:42 +03:00
type : OC . SetupChecks . MESSAGE _TYPE _INFO
2015-07-29 17:41:22 +03:00
} ) ;
2015-03-26 16:51:33 +03:00
}
2015-05-26 15:11:38 +03:00
if ( ! data . isUrandomAvailable ) {
2015-07-29 18:40:42 +03:00
messages . push ( {
2015-12-21 21:28:32 +03:00
msg : t ( 'core' , '/dev/urandom is not readable by PHP which is highly discouraged for security reasons. Further information can be found in our <a target="_blank" href="{docLink}">documentation</a>.' , { docLink : data . securityDocs } ) ,
2015-07-29 18:40:42 +03:00
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
2015-05-26 15:11:38 +03:00
}
2015-07-27 17:29:05 +03:00
if ( data . isUsedTlsLibOutdated ) {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : data . isUsedTlsLibOutdated ,
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
2015-07-27 17:29:05 +03:00
}
2015-07-28 11:06:26 +03:00
if ( data . phpSupported && data . phpSupported . eol ) {
2015-08-18 15:42:57 +03:00
messages . push ( {
2015-12-21 21:28:32 +03:00
msg : t ( 'core' , 'Your PHP version ({version}) is no longer <a target="_blank" href="{phpLink}">supported by PHP</a>. We encourage you to upgrade your PHP version to take advantage of performance and security updates provided by PHP.' , { version : data . phpSupported . version , phpLink : 'https://secure.php.net/supported-versions.php' } ) ,
2015-08-18 15:42:57 +03:00
type : OC . SetupChecks . MESSAGE _TYPE _INFO
} ) ;
2015-07-28 11:06:26 +03:00
}
2015-07-25 21:18:32 +03:00
if ( ! data . forwardedForHeadersWorking ) {
2015-08-18 15:42:57 +03:00
messages . push ( {
2015-12-21 21:28:32 +03:00
msg : t ( 'core' , 'The reverse proxy headers configuration is incorrect, or you are accessing ownCloud from a trusted proxy. If you are not accessing ownCloud from a trusted proxy, this is a security issue and can allow an attacker to spoof their IP address as visible to ownCloud. Further information can be found in our <a target="_blank" href="{docLink}">documentation</a>.' , { docLink : data . reverseProxyDocs } ) ,
2015-08-18 15:42:57 +03:00
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
2015-07-25 21:18:32 +03:00
}
2015-10-02 17:17:56 +03:00
if ( ! data . isCorrectMemcachedPHPModuleInstalled ) {
messages . push ( {
2015-12-21 21:28:32 +03:00
msg : t ( 'core' , 'Memcached is configured as distributed cache, but the wrong PHP module "memcache" is installed. \\OC\\Memcache\\Memcached only supports "memcached" and not "memcache". See the <a target="_blank" href="{wikiLink}">memcached wiki about both modules</a>.' , { wikiLink : 'https://code.google.com/p/memcached/wiki/PHPClientComparison' } ) ,
2015-10-02 17:17:56 +03:00
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
}
Add code integrity check
This PR implements the base foundation of the code signing and integrity check. In this PR implemented is the signing and verification logic, as well as commands to sign single apps or the core repository.
Furthermore, there is a basic implementation to display problems with the code integrity on the update screen.
Code signing basically happens the following way:
- There is a ownCloud Root Certificate authority stored `resources/codesigning/root.crt` (in this PR I also ship the private key which we obviously need to change before a release :wink:). This certificate is not intended to be used for signing directly and only is used to sign new certificates.
- Using the `integrity:sign-core` and `integrity:sign-app` commands developers can sign either the core release or a single app. The core release needs to be signed with a certificate that has a CN of `core`, apps need to be signed with a certificate that either has a CN of `core` (shipped apps!) or the AppID.
- The command generates a signature.json file of the following format:
```json
{
"hashes": {
"/filename.php": "2401fed2eea6f2c1027c482a633e8e25cd46701f811e2d2c10dc213fd95fa60e350bccbbebdccc73a042b1a2799f673fbabadc783284cc288e4f1a1eacb74e3d",
"/lib/base.php": "55548cc16b457cd74241990cc9d3b72b6335f2e5f45eee95171da024087d114fcbc2effc3d5818a6d5d55f2ae960ab39fd0414d0c542b72a3b9e08eb21206dd9"
},
"certificate": "-----BEGIN CERTIFICATE-----MIIBvTCCASagAwIBAgIUPvawyqJwCwYazcv7iz16TWxfeUMwDQYJKoZIhvcNAQEF\nBQAwIzEhMB8GA1UECgwYb3duQ2xvdWQgQ29kZSBTaWduaW5nIENBMB4XDTE1MTAx\nNDEzMTcxMFoXDTE2MTAxNDEzMTcxMFowEzERMA8GA1UEAwwIY29udGFjdHMwgZ8w\nDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBANoQesGdCW0L2L+a2xITYipixkScrIpB\nkX5Snu3fs45MscDb61xByjBSlFgR4QI6McoCipPw4SUr28EaExVvgPSvqUjYLGps\nfiv0Cvgquzbx/X3mUcdk9LcFo1uWGtrTfkuXSKX41PnJGTr6RQWGIBd1V52q1qbC\nJKkfzyeMeuQfAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAvF/KIhRMQ3tYTmgHWsiM\nwDMgIDb7iaHF0fS+/Nvo4PzoTO/trev6tMyjLbJ7hgdCpz/1sNzE11Cibf6V6dsz\njCE9invP368Xv0bTRObRqeSNsGogGl5ceAvR0c9BG+NRIKHcly3At3gLkS2791bC\niG+UxI/MNcWV0uJg9S63LF8=\n-----END CERTIFICATE-----",
"signature": "U29tZVNpZ25lZERhdGFFeGFtcGxl"
}
```
`hashes` is an array of all files in the folder with their corresponding SHA512 hashes (this is actually quite cheap to calculate), the `certificate` is the certificate used for signing. It has to be issued by the ownCloud Root Authority and it's CN needs to be permitted to perform the required action. The `signature` is then a signature of the `hashes` which can be verified using the `certificate`.
Steps to do in other PRs, this is already a quite huge one:
- Add nag screen in case the code check fails to ensure that administrators are aware of this.
- Add code verification also to OCC upgrade and unify display code more.
- Add enforced code verification to apps shipped from the appstore with a level of "official"
- Add enfocrced code verification to apps shipped from the appstore that were already signed in a previous release
- Add some developer documentation on how devs can request their own certificate
- Check when installing ownCloud
- Add support for CRLs to allow revoking certificates
**Note:** The upgrade checks are only run when the instance has a defined release channel of `stable` (defined in `version.php`). If you want to test this, you need to change the channel thus and then generate the core signature:
```
➜ master git:(add-integrity-checker) ✗ ./occ integrity:sign-core --privateKey=resources/codesigning/core.key --certificate=resources/codesigning/core.crt
Successfully signed "core"
```
Then increase the version and you should see something like the following:
![2015-11-04_12-02-57](https://cloud.githubusercontent.com/assets/878997/10936336/6adb1d14-82ec-11e5-8f06-9a74801c9abf.png)
As you can see a failed code check will not prevent the further update. It will instead just be a notice to the admin. In a next step we will add some nag screen.
For packaging stable releases this requires the following additional steps as a last action before zipping:
1. Run `./occ integrity:sign-core` once
2. Run `./occ integrity:sign-app` _for each_ app. However, this can be simply automated using a simple foreach on the apps folder.
2015-11-03 22:26:06 +03:00
if ( ! data . hasPassedCodeIntegrityCheck ) {
messages . push ( {
msg : t (
'core' ,
2015-12-21 21:28:32 +03:00
'Some files have not passed the integrity check. Further information on how to resolve this issue can be found in our <a target="_blank" href="{docLink}">documentation</a>. (<a href="{codeIntegrityDownloadEndpoint}">List of invalid files…</a> / <a href="{rescanEndpoint}">Rescan…</a>)' ,
Add code integrity check
This PR implements the base foundation of the code signing and integrity check. In this PR implemented is the signing and verification logic, as well as commands to sign single apps or the core repository.
Furthermore, there is a basic implementation to display problems with the code integrity on the update screen.
Code signing basically happens the following way:
- There is a ownCloud Root Certificate authority stored `resources/codesigning/root.crt` (in this PR I also ship the private key which we obviously need to change before a release :wink:). This certificate is not intended to be used for signing directly and only is used to sign new certificates.
- Using the `integrity:sign-core` and `integrity:sign-app` commands developers can sign either the core release or a single app. The core release needs to be signed with a certificate that has a CN of `core`, apps need to be signed with a certificate that either has a CN of `core` (shipped apps!) or the AppID.
- The command generates a signature.json file of the following format:
```json
{
"hashes": {
"/filename.php": "2401fed2eea6f2c1027c482a633e8e25cd46701f811e2d2c10dc213fd95fa60e350bccbbebdccc73a042b1a2799f673fbabadc783284cc288e4f1a1eacb74e3d",
"/lib/base.php": "55548cc16b457cd74241990cc9d3b72b6335f2e5f45eee95171da024087d114fcbc2effc3d5818a6d5d55f2ae960ab39fd0414d0c542b72a3b9e08eb21206dd9"
},
"certificate": "-----BEGIN CERTIFICATE-----MIIBvTCCASagAwIBAgIUPvawyqJwCwYazcv7iz16TWxfeUMwDQYJKoZIhvcNAQEF\nBQAwIzEhMB8GA1UECgwYb3duQ2xvdWQgQ29kZSBTaWduaW5nIENBMB4XDTE1MTAx\nNDEzMTcxMFoXDTE2MTAxNDEzMTcxMFowEzERMA8GA1UEAwwIY29udGFjdHMwgZ8w\nDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBANoQesGdCW0L2L+a2xITYipixkScrIpB\nkX5Snu3fs45MscDb61xByjBSlFgR4QI6McoCipPw4SUr28EaExVvgPSvqUjYLGps\nfiv0Cvgquzbx/X3mUcdk9LcFo1uWGtrTfkuXSKX41PnJGTr6RQWGIBd1V52q1qbC\nJKkfzyeMeuQfAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAvF/KIhRMQ3tYTmgHWsiM\nwDMgIDb7iaHF0fS+/Nvo4PzoTO/trev6tMyjLbJ7hgdCpz/1sNzE11Cibf6V6dsz\njCE9invP368Xv0bTRObRqeSNsGogGl5ceAvR0c9BG+NRIKHcly3At3gLkS2791bC\niG+UxI/MNcWV0uJg9S63LF8=\n-----END CERTIFICATE-----",
"signature": "U29tZVNpZ25lZERhdGFFeGFtcGxl"
}
```
`hashes` is an array of all files in the folder with their corresponding SHA512 hashes (this is actually quite cheap to calculate), the `certificate` is the certificate used for signing. It has to be issued by the ownCloud Root Authority and it's CN needs to be permitted to perform the required action. The `signature` is then a signature of the `hashes` which can be verified using the `certificate`.
Steps to do in other PRs, this is already a quite huge one:
- Add nag screen in case the code check fails to ensure that administrators are aware of this.
- Add code verification also to OCC upgrade and unify display code more.
- Add enforced code verification to apps shipped from the appstore with a level of "official"
- Add enfocrced code verification to apps shipped from the appstore that were already signed in a previous release
- Add some developer documentation on how devs can request their own certificate
- Check when installing ownCloud
- Add support for CRLs to allow revoking certificates
**Note:** The upgrade checks are only run when the instance has a defined release channel of `stable` (defined in `version.php`). If you want to test this, you need to change the channel thus and then generate the core signature:
```
➜ master git:(add-integrity-checker) ✗ ./occ integrity:sign-core --privateKey=resources/codesigning/core.key --certificate=resources/codesigning/core.crt
Successfully signed "core"
```
Then increase the version and you should see something like the following:
![2015-11-04_12-02-57](https://cloud.githubusercontent.com/assets/878997/10936336/6adb1d14-82ec-11e5-8f06-9a74801c9abf.png)
As you can see a failed code check will not prevent the further update. It will instead just be a notice to the admin. In a next step we will add some nag screen.
For packaging stable releases this requires the following additional steps as a last action before zipping:
1. Run `./occ integrity:sign-core` once
2. Run `./occ integrity:sign-app` _for each_ app. However, this can be simply automated using a simple foreach on the apps folder.
2015-11-03 22:26:06 +03:00
{
docLink : data . codeIntegrityCheckerDocumentation ,
codeIntegrityDownloadEndpoint : OC . generateUrl ( '/settings/integrity/failed' ) ,
rescanEndpoint : OC . generateUrl ( '/settings/integrity/rescan?requesttoken={requesttoken}' , { 'requesttoken' : OC . requestToken } )
}
) ,
type : OC . SetupChecks . MESSAGE _TYPE _ERROR
} ) ;
}
2014-02-03 15:48:17 +04:00
} else {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'Error occurred while checking server setup' ) ,
type : OC . SetupChecks . MESSAGE _TYPE _ERROR
} ) ;
2014-02-03 15:48:17 +04:00
}
deferred . resolve ( messages ) ;
} ;
$ . ajax ( {
type : 'GET' ,
url : OC . generateUrl ( 'settings/ajax/checksetup' )
} ) . then ( afterCall , afterCall ) ;
return deferred . promise ( ) ;
2015-01-19 13:56:04 +03:00
} ,
/ * *
* Runs generic checks on the server side , the difference to dedicated
* methods is that we use the same XHR object for all checks to save
* requests .
*
* @ return $ . Deferred object resolved with an array of error messages
* /
checkGeneric : function ( ) {
var self = this ;
var deferred = $ . Deferred ( ) ;
var afterCall = function ( data , statusText , xhr ) {
var messages = [ ] ;
messages = messages . concat ( self . _checkSecurityHeaders ( xhr ) ) ;
messages = messages . concat ( self . _checkSSL ( xhr ) ) ;
deferred . resolve ( messages ) ;
} ;
$ . ajax ( {
type : 'GET' ,
url : OC . generateUrl ( 'heartbeat' )
} ) . then ( afterCall , afterCall ) ;
return deferred . promise ( ) ;
} ,
/ * *
* Runs check for some generic security headers on the server side
*
* @ param { Object } xhr
* @ return { Array } Array with error messages
* /
_checkSecurityHeaders : function ( xhr ) {
var messages = [ ] ;
if ( xhr . status === 200 ) {
var securityHeaders = {
'X-XSS-Protection' : '1; mode=block' ,
'X-Content-Type-Options' : 'nosniff' ,
'X-Robots-Tag' : 'none' ,
'X-Frame-Options' : 'SAMEORIGIN'
} ;
for ( var header in securityHeaders ) {
2015-03-26 17:30:00 +03:00
if ( ! xhr . getResponseHeader ( header ) || xhr . getResponseHeader ( header ) . toLowerCase ( ) !== securityHeaders [ header ] . toLowerCase ( ) ) {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'The "{header}" HTTP header is not configured to equal to "{expected}". This is a potential security or privacy risk and we recommend adjusting this setting.' , { header : header , expected : securityHeaders [ header ] } ) ,
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
2015-01-19 13:56:04 +03:00
}
}
} else {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'Error occurred while checking server setup' ) ,
type : OC . SetupChecks . MESSAGE _TYPE _ERROR
} ) ;
2015-01-19 13:56:04 +03:00
}
return messages ;
} ,
/ * *
* Runs check for some SSL configuration issues on the server side
*
* @ param { Object } xhr
* @ return { Array } Array with error messages
* /
_checkSSL : function ( xhr ) {
var messages = [ ] ;
if ( xhr . status === 200 ) {
if ( OC . getProtocol ( ) === 'https' ) {
// Extract the value of 'Strict-Transport-Security'
var transportSecurityValidity = xhr . getResponseHeader ( 'Strict-Transport-Security' ) ;
if ( transportSecurityValidity !== null && transportSecurityValidity . length > 8 ) {
var firstComma = transportSecurityValidity . indexOf ( ";" ) ;
if ( firstComma !== - 1 ) {
2015-06-15 11:39:25 +03:00
transportSecurityValidity = transportSecurityValidity . substring ( 8 , firstComma ) ;
2015-01-19 13:56:04 +03:00
} else {
transportSecurityValidity = transportSecurityValidity . substring ( 8 ) ;
}
}
2015-06-15 11:39:25 +03:00
var minimumSeconds = 15768000 ;
if ( isNaN ( transportSecurityValidity ) || transportSecurityValidity <= ( minimumSeconds - 1 ) ) {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'The "Strict-Transport-Security" HTTP header is not configured to least "{seconds}" seconds. For enhanced security we recommend enabling HSTS as described in our <a href="{docUrl}">security tips</a>.' , { 'seconds' : minimumSeconds , docUrl : '#admin-tips' } ) ,
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
2015-01-19 13:56:04 +03:00
}
} else {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'You are accessing this site via HTTP. We strongly suggest you configure your server to require using HTTPS instead as described in our <a href="{docUrl}">security tips</a>.' , { docUrl : '#admin-tips' } ) ,
type : OC . SetupChecks . MESSAGE _TYPE _WARNING
} ) ;
2015-01-19 13:56:04 +03:00
}
} else {
2015-07-29 18:40:42 +03:00
messages . push ( {
msg : t ( 'core' , 'Error occurred while checking server setup' ) ,
type : OC . SetupChecks . MESSAGE _TYPE _ERROR
} ) ;
2015-01-19 13:56:04 +03:00
}
return messages ;
2014-02-03 15:48:17 +04:00
}
} ;
} ) ( ) ;