BookStack Code Mirror - website/blob - content/docs/admin/security.md

   1 +++
   2 title = "Security"
   3 description = "BookStack security concerns and considerations"
   4 date = "2017-01-01"
   5 type = "admin-doc"
   6 +++
   7
   8 Since BookStack can hold important information for users you should be aware of any potential security concerns.
   9 Read through the below to ensure you have secured your BookStack instance. Note, The below only
  10 relates to BookStack itself. The security of the server BookStack is hosted on is not instructed below but should be taken into account.
  11
  12 If you'd like to be notified of new potential security concerns you can sign-up to the [BookStack security mailing list](https://updates.bookstackapp.com/signup/bookstack-security-updates). For reporting security vulnerabilities, please see the ["Security" section](https://github.com/BookStackApp/BookStack/blob/development/readme.md#-security) of the project readme on GitHub.
  13
  14
  15 {{<toc>}}
  16
  17 ---
  18
  19 ### Initial Security Setup
  20
  21 1. Ensure you change the password and email address for the initial `admin@admin.com` user.
  22 2. Ensure only the `public` folder is being served by your webserver. Serving files above this folder
  23 opens up a lot of code that does not need to be public. Triple check this if you have installed
  24 BookStack within the commonly used `/var/www` folder.
  25 3. Ensure the database user you've used for BookStack has limited permissions for only accessing
  26 the database used for BookStack data.
  27 4. Check that you've set the `APP_URL` option in your `.env` file so that system generated URLs cannot be manipulated.
  28 5. Within BookStack, go through the settings to ensure registration and public access settings are as you expect.
  29 6. Review the user roles in the settings area.
  30 7. Read the below to further understand the security for specific functionality and features.
  31
  32 ---
  33
  34 ### Multi-Factor Authentication
  35
  36 Any user can enable multi-factor authentication (MFA) on their account. Upon login they would then need to use an extra proof of identity
  37 to gain access. BookStack currently supports the following mechanisms:
  38
  39 - TOTP (Time-based One-Time Passwords)
  40   - Labelled as "Mobile App" (Google/Microsoft Authenticator etc...).
  41   - Uses a SHA1 algorithm internally (Greater algorithms have poor cross-app compatibility).
  42 - Backup Codes
  43   - These are a list of 16 one-time-use codes.
  44   - Users will be warned once they have less than 5 codes remaining.
  45
  46 Secrets and values for these options are stored encrypted within the database.
  47
  48 Where required, MFA can be forced upon users via their roles. This can be found via
  49 a "Requires Multi-Factor Authentication" checkbox seen when editing a role.
  50 If a user does not already have an MFA method configured, they will be forced to set one up
  51 upon next login.
  52
  53 ---
  54
  55 ### Securing Images
  56
  57 By default, images are stored in a way which is publicly accessible which ensures performance while using BookStack.
  58 Listed below are methods for increasing image security where needed.
  59
  60 #### File Storage Options
  61
  62 In our [file upload storage options](/docs/admin/upload-config/#storage-options) documentation we list the available options
  63 for storing file uploads, along with the permission controls and extra considerations for each.
  64 You should review the available options to determine what works best for your use-case.
  65
  66 #### Complex URLs
  67
  68 In the settings area of BookStack you can find the option 'Enable higher security image uploads?'. Enabling this will add a 16 character
  69 random string to the name of image files to prevent easy guessing of URLs. This increases security without potential performance concerns.
  70
  71 #### Prevent Directory Indexes
  72
  73 It's important to ensure you disable 'directory indexes' to prevent unknown users from being able to navigate their way through your images. Here's the configuration for NGINX & Apache if your server allows directory indexes:
  74
  75 **NGINX**
  76
  77 ```nginx
  78 # By default indexes are disabled on NGINX but if you have them enabled
  79 # add this to your BookStack server block
  80 location /uploads {
  81        autoindex off;
  82 }
  83 ```
  84
  85 **Apache**
  86
  87 ```apache
  88 # Add this to your Apache BookStack virtual host if Indexes are enabled.
  89 # If .htaccess file are enabled then the below should already be active.
  90 <Location "/uploads">
  91     Options -Indexes
  92 </Location>
  93 ```
  94
  95 You can test that indexes are disabled by attempting to navigate to
  96 `<your_bookstack_url>/uploads/images` in the browser after having uploaded at least one image.
  97 You should not see a list of files but instead a BookStack "Not Found" page.
  98
  99 ---
 100
 101 ### Attachments
 102
 103 Attachments, if not using Amazon S3, are stored in the `storage/uploads` directory.
 104 By default, unlike images, these are stored behind the application authentication layer so access
 105 depends on permissions you have set up at a role level and page level.
 106
 107 If you are using Amazon S3 for file storage then access will depend on your S3 permission
 108 settings. Unlike images, BookStack will not automatically attempt to make uploaded attachments
 109 publicly accessible.
 110
 111 ---
 112
 113 ### Filesystem Permissions
 114
 115 It's usually a good idea to limit the file and folder access privileges for the user/group used to run the application PHP, which is typically the user/group for PHP or the running web-server processes. Limiting permissions can help avoid a range of potential vulnerability exploits.
 116
 117 Details on required [filesystem permissions can be found here](/docs/admin/filesystem-permissions/).
 118
 119 ---
 120
 121 ### User Passwords
 122
 123 User passwords, if not using an alternative authentication method, are stored in the database.
 124 These are hashed using the standard Laravel hashing methods which use the Bcrypt hashing algorithm.
 125
 126 ---
 127
 128 ### JavaScript in Page Content
 129
 130 By default, JavaScript tags within page content is escaped when rendered. This can be turned off by setting `ALLOW_CONTENT_SCRIPTS=true` in your `.env` file. Note that even if you disable this escaping the WYSIWYG editor may still perform its own JavaScript escaping. This option will also alter the [CSP rules](#content-security-policy-csp) set by BookStack.
 131
 132 ***This option disables some fundamental cross-site-scripting protections. Only use this option on secure instances, where only very trusted users can edit content***
 133
 134 ---
 135
 136 ### Web Crawler Control
 137
 138 The rules found in the `/robots.txt` file are automatically controlled via the "Allow public viewing?" setting. This can be overridden by setting `ALLOW_ROBOTS=false` or `ALLOW_ROBOTS=true` in your `.env` file. If you'd like to customise the rules this can be done via theme overrides.
 139
 140 ---
 141
 142 ### Secure Cookies
 143
 144 BookStack uses cookies to track sessions, remember logins and for XSRF protection. When using HTTPS you may want to ensure that cookies are only sent back to the browser if the connection is over HTTPS. If you have set a https `APP_URL` option in your `.env` this will enabled automatically but it can also be forced on by setting `SESSION_SECURE_COOKIE=true` in your `.env` file.
 145
 146 ---
 147
 148 ### Host Iframe Control
 149
 150 By default BookStack will only allow itself to be embedded within iframes on the same domain as you're hosting on. This is done through a [CSP: frame-ancestors](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors) header. You can add additional trusted hosts by setting a `ALLOWED_IFRAME_HOSTS` option in your `.env` file like the example below:
 151
 152 ```bash
 153 # Adding a single host
 154 ALLOWED_IFRAME_HOSTS="https://example.com"
 155
 156 # Multiple hosts can be separated with a space
 157 ALLOWED_IFRAME_HOSTS="https://a.example.com https://b.example.com"
 158 ```
 159
 160 Note: when this option is used, all cookies will served with `SameSite=None` [(info)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite#None) set so that
 161 a user session can persist within the iframe.
 162
 163 ---
 164
 165 <a name="iframe-src-control"></a>
 166
 167 ### Iframe Source Control
 168
 169 By default BookStack will only allow certain other hosts to be used as `src` values for embedded iframe/frame content within the application. This is done through a [CSP: frame-src](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-src) header. You can configure the list of trusted sources by setting a `ALLOWED_IFRAME_SOURCES` option in your `.env` file like the examples below:
 170
 171 ```bash
 172 # Adding a single host
 173 ALLOWED_IFRAME_SOURCES="https://example.com"
 174
 175 # Multiple hosts can be separated with a space
 176 ALLOWED_IFRAME_SOURCES="https://a.example.com https://b.example.com"
 177
 178 # Allow all sources
 179 # This opens vulnerability risk and should only be done in secure & trusted environments.
 180 ALLOWED_IFRAME_SOURCES="*"
 181 ```
 182
 183 By default this option is configured as follows:
 184
 185 ```bash
 186 ALLOWED_IFRAME_SOURCES="https://*.draw.io https://*.youtube.com https://*.youtube-nocookie.com https://*.vimeo.com"
 187 ```
 188
 189 Note: The source of 'self' will always be automatically added to this CSP rule. In addition, the host used for the diagrams.net integration (If enabled) will be automatically appended to the lists of hosts.
 190
 191 ---
 192
 193 ### Failed Access Logging
 194
 195 An option is available to log failed login events to a log file which is useful to identify users having trouble logging in, track malicious login attempts or to use with tools such as Fail2Ban. This works with login attempts using the default email & password login mechanism or attempts via LDAP login. Failed attempts are **not logged** for "one-click" social or SAML2 options.
 196
 197 To enable this you simply need to define the `LOG_FAILED_LOGIN_MESSAGE` option in your `.env` file like so:
 198
 199 ```bash
 200 LOG_FAILED_LOGIN_MESSAGE="Failed login for %u"
 201 ```
 202
 203 The optional "%u" element of the message will be replaced with the username or email provided in the login attempt
 204 when the message is logged. By default messages will be logged via the php `error_log` function which, in most
 205 cases, will log to your webserver error log files.
 206
 207 ---
 208
 209 ### Untrusted Server Side Requests
 210
 211 Some features, such as the PDF exporting, have the option to make http calls to external user-defined locations to do things
 212 such as load images or styles. This is disabled by default but can be enabled if desired. This is required for using
 213 WKHTMLtoPDF as your PDF export renderer.
 214 This should only be enabled in BookStack environments where BookStack users and viewers are fully trusted.
 215
 216 To enable untrusted server side requests, you need to define the `ALLOW_UNTRUSTED_SERVER_FETCHING` option in your `.env` file like so:
 217
 218 ```bash
 219 ALLOW_UNTRUSTED_SERVER_FETCHING=true
 220 ```
 221
 222 Note that this is not connected to the `ALLOWED_SSR_HOSTS` setting at all.
 223 `ALLOW_UNTRUSTED_SERVER_FETCHING` is used for typically "untrusted" scenarios/functionality
 224 whereas `ALLOWED_SSR_HOSTS` is used for typically "trusted" user scenarios/functionality
 225 (where admin-level permissions are required).
 226
 227 ---
 228
 229 ### Server Side Request Allow List
 230
 231 There is some functionality in BookStack, like webhooks for example, that is typically only
 232 accessible by trusted (admin-level) users.
 233 In some cases, those admin users may not be trusted to the level where they can freely make server
 234 side requests. In such scenarios, you can define a `ALLOWED_SSR_HOSTS` option in your `.env` file
 235 to limit the hosts that can be called for such typically trusted functionality:
 236
 237 ```bash
 238 # Allow all hosts (Default)
 239 ALLOWED_SSR_HOSTS="*"
 240
 241 # Allow a single host
 242 ALLOWED_SSR_HOSTS="https://example.com"
 243
 244 # Allow multiple hosts via space-separated entries
 245 ALLOWED_SSR_HOSTS="https://example.com https://example.org"
 246
 247 # Use '*' as wildcards and/or define required paths
 248 ALLOWED_SSR_HOSTS="https://*.example.com https://example.org/bookstack/"
 249 ```
 250
 251 Values will be compared prefix-matched, case-insensitive, against called SSR urls.
 252
 253 Note that this is not connected to the `ALLOW_UNTRUSTED_SERVER_FETCHING` setting at all.
 254 `ALLOW_UNTRUSTED_SERVER_FETCHING` is used for typically "untrusted" scenarios/functionality
 255 whereas `ALLOWED_SSR_HOSTS` is used for typically "trusted" user scenarios/functionality
 256 (where admin-level permissions are required).
 257
 258 ---
 259
 260 ### Content Security Policy (CSP)
 261
 262 BookStack serves responses with a CSP header to increase protection again malicious content.
 263 This is especially important in a system such as BookStack where users can create a variety of HTML content,
 264 especially so if you allow untrusted users to create content in your instance.
 265 The CSP rules set by BookStack are as follows:
 266
 267 - `frame-ancestors 'self'`
 268   - Restricts what websites can embed BookStack pages via iframes.
 269   - See the "[Host Iframe Control](#iframe-control)" section above for details on expanding this rule to other hosts.
 270 - `frame-source 'self' https://*.diagrams.net https://*.draw.io https://*.youtube.com https://*.youtube-nocookie.com https://*.vimeo.com https://embed.diagrams.net`
 271   - Restricts what sources are allowed to load for frames/iframes.
 272   - Can be configured via a `ALLOWED_IFRAME_SOURCES` .env option.
 273   - May be different depending on other configuration set.
 274 - `script-src http: https: 'nonce-abc123' 'strict-dynamic'`
 275   - Restricts what scripts can be ran on a BookStack-served page.
 276   - Will not be set if the `ALLOW_CONTENT_SCRIPTS` .env option is active.
 277   - The nonce value used is randomly generated upon each request. It is automatically applied to any "Custom HTML Head Content" scripts.
 278 - `object-src 'self'`
 279   - Restricts which embeddable content can be loaded onto a BookStack-served page.
 280   - Will not be set if the `ALLOW_CONTENT_SCRIPTS` .env option is active.
 281 - `base-uri 'self'`
 282   - Restricts what `<base>` tags can be added to a BookStack-served page.
 283
 284 If needed you should be able to set additional CSP headers via your webserver.
 285 If there's a clash with an existing BookStack CSP header then browsers will generally favour the most restrictive policy.
 286
 287 ---
 288
 289 ### MySQL SSL Connection
 290
 291 If your BookStack database is not on the same host as your web server, you may want to ensure the connection is encrypted using SSL between these systems.
 292 Assuming SSL is configured correctly on your MySQL server, you can enable this by defining the `MYSQL_ATTR_SSL_CA` option in your `.env` file like so:
 293
 294 ```bash
 295 # Path to Certificate Authority (CA) certificate file for your MySQL instance.
 296 # When this option is used host name identity verification will be performed
 297 # which checks the hostname, used by the client, against names within the
 298 # certificate itself (Common Name or Subject Alternative Name).
 299 MYSQL_ATTR_SSL_CA="/path/to/ca.pem"
 300 ```
 301
 302 ---
 303
 304 ### Using BookStack Content Externally
 305
 306 In some scenarios you may use BookStack user-provided content externally (Accessed via the database or API). Such content is not guaranteed to be safe so keep security in mind when dealing with such content. In some cases, the system will apply some filtering to content in an attempt to prevent certain vulnerabilities, but this is not assured to be a bullet-proof defence.
 307
 308 Within its own interfaces, unless disabled, BookStack makes use of Content Security Policy (CSP) rules to heavily negate cross-site scripting vulnerabilities from user content. If displaying user content externally, it's advised you also use defences such as CSP or other techniques such as disabling of JavaScript entirely.