View source for Ruby on Rails Cheatsheet

 __NOTOC__
<div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:Cheatsheets-header.jpg|link=]]</div>

{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
| valign="top"  style="border-right: 1px dotted gray;padding-right:25px;" |
Last revision (mm/dd/yy): '''{{REVISIONMONTH}}/{{REVISIONDAY}}/{{REVISIONYEAR}}''' 
= Introduction  =
 __TOC__{{TOC hidden}}

This ''Cheatsheet'' intends to provide quick basic Ruby on Rails security tips for developers. It complements, augments or emphasizes points brought up in the [http://guides.rubyonrails.org/security.html rails security guide] from rails core. The Rails framework abstracts developers from quite a bit of tedious work and provides the means to accomplish complex tasks quickly and with ease. New developers, those unfamiliar with the inner-workings of Rails, likely need a basic set of guidelines to secure fundamental aspects of their application. The intended purpose of this doc is to be that guide.

= Items =
== Command Injection == 

Ruby offers a function called “eval” which will dynamically build new Ruby code based on Strings.  It also has a number of ways to call system commands.

    <syntaxhighlight lang="ruby" line='line'>
    eval("ruby code here")
    System("os command here")
    `ls -al /`   (backticks contain os command)
    Kernel.exec("os command here")
    open("| os command here")
    </syntaxhighlight>

While the power of these commands is quite useful, extreme care should be taken when using them in a Rails based application.  Usually, its just a bad idea.  If need be, a whitelist of possible values should be used and any input should be validated as thoroughly as possible.  The Ruby Security Reviewer's Guide has a  [http://code.google.com/p/ruby-security/wiki/Guide#Good_ol%27_shell_injection section on injection]  and there are a number of OWASP references for it, starting at the top:  [[Command Injection]].

== SQL Injection == 

Ruby on Rails is often used with an ORM called ActiveRecord, though it is flexible and can be used with other data sources.  Typically very simple Rails applications use methods on the Rails models to query data.  Many use cases protect for SQL Injection out of the box.  However, it is possible to write code that allows for SQL Injection.  

Here is an example (Rails 2.X style):

    <syntaxhighlight lang="ruby" line='line'>
    @projects = Project.find(:all, :conditions => “name like #{params[:name]}”)
    </syntaxhighlight>

A Rails 3.X example:

    <syntaxhighlight lang="ruby" line='line'>
    name = params[:name]
    @projects = Project.where(“name like ‘“ + name + “‘“);
    </syntaxhighlight>

In both of these cases, the statement is injectable because the name parameter is not escaped.  

Here is the idiom for building this kind of statement:

    <syntaxhighlight lang="ruby" line='line'>
    @projects = Project.find(:all, :conditions => [ “name like ?”, “#{params[:name]}”] )
    </syntaxhighlight>

An AREL based solution:

    <syntaxhighlight lang="ruby" line='line'>
    @projects = Project.where("name like ?", "%#{params[:name]}%")
    </syntaxhighlight>

Use caution not to build SQL statements based on user controlled input.  A list of more realistic and detailed examples is here: [http://rails-sqli.org rails-sqli.org].  OWASP has extensive information about [[SQL Injection]].

== Cross-site Scripting (XSS) == 

By default, in Rails 3.0 protection against XSS comes as the default behavior.  When string data is shown in views, it is escaped prior to being sent back to the browser.  This goes a long way, but there are common cases where developers bypass this protection - for example to enable rich text editing.  In the event that you want to pass variables to the front end with tags intact, it is tempting to do the following in your .erb file (ruby markup).

    <syntaxhighlight lang="ruby" line='line'>
    <%= raw @product.name %>   
    <%= @product.name.html_safe %>       These are examples of how NOT to do it!
    <%= content_tag @product.name %>
    </syntaxhighlight>

Unfortunately, any field that uses raw like this will be a potential XSS target.  Note that there are also widespread misunderstandings about html_safe.  [http://stackoverflow.com/questions/4251284/raw-vs-html-safe-vs-h-to-unescape-html This writeup] describes the underlying SafeBuffer mechanism in detail.  Other tags that change the way strings are prepared for output can introduce similar issues, including content_tag.

If you must accept HTML content from users, consider a markup language for rich text in an application (Examples include:  markdown and textile) and disallow HTML tags. This helps ensures that the input accepted doesn’t include HTML content that could be malicious. If you cannot restrict your users from entering HTML, consider implementing content security policy to disallow the execution of any javascript. And finally, consider using the #sanitize method that let's you whitelist allowed tags. Be careful, this method has been shown to be flawed numerous times and will never be a complete solution.

An often overlooked XSS attack vector is the href value of a link:

    <syntaxhighlight lang="ruby" line='line'>
    <%= link_to “Personal Website”, @user.website %>
    </syntaxhighlight>

If @user.website contains a link that starts with “javascript:”, the content will execute when a user clicks the generated link:

    <syntaxhighlight lang="ruby" line='line'>
    <a href=”javascript:alert(‘Haxored’)”>Personal Website</a>
    </syntaxhighlight>

OWASP provides more general information about XSS in a top level page: [[Cross-site Scripting (XSS)]].

== Sessions ==

By default, Ruby on Rails uses a Cookie based session store.  What that means is that unless you change something, the session will not expire on the server.  That means that some default applications may be vulnerable to replay attacks.  It also means that sensitive information should never be put in the session.

The best practice is to use a database based session, which thankfully is very easy with Rails:

    <syntaxhighlight lang="ruby" line='line'>
    Project::Application.config.session_store :active_record_store
    </syntaxhighlight>

There is an OWASP [[Session Management Cheat Sheet]].

== Authentication == 

As with all sensitive data, start securing your authentication with enabling TLS in your configuration:

  <syntaxhighlight lang="ruby" line='line'>
  # config/environments/production.rb
  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies
  config.force_ssl = true
  </syntaxhighlight>

Uncomment the line 3 as above in your configuration.
 
Generally speaking, Rails does not provide authentication by itself.  However, most developers using Rails leverage libraries such as Devise or AuthLogic to provide authentication.  

To enable authentication it is possible to use Devise gem.

Install it using:
    
    gem 'devise'

Then install it to the user model:

    rails generate devise:install

Next, specify which resources (routes) require authenticated access in routes:

    <syntaxhighlight lang="ruby" line='line'>
    Rails.application.routes.draw do
      authenticate :user do
        resources :something do  # these resource require authentication
         ...
        end
      end
  
      devise_for :users # sign-up/-in/out routes

      root to: 'static#home' # no authentication required
  
    end
    </syntaxhighlight>

To enforce password complexity, it is possible to use [https://github.com/bitzesty/devise_zxcvbn zxcvbn gem].
Configure your user model with it:

    <syntaxhighlight lang="ruby" line='line'>
    class User < ApplicationRecord
      devise :database_authenticatable, 
        # other devise features, then
        :zxcvbnable
    end
    </syntaxhighlight>

And configure the required password complexity:

    <syntaxhighlight lang="ruby" line='line'>
    # in config/initializers/devise.rb
    Devise.setup do |config|
      # zxcvbn score for devise
      config.min_password_score = 4 # complexity score here.
      ...
    </syntaxhighlight>



You can try out [https://github.com/qutorial/revise this PoC], to learn more about it.


Next, [https://github.com/omniauth/omniauth omniauth gem] allows for multiple strategies 
for authentication. Using it one can configure secure authentication with Facebook, LDAP
and many other providers. Read on [https://github.com/omniauth/omniauth#integrating-omniauth-into-your-application here].

=== Token Authentication ===

Devise usually uses Cookies for authentication.

In the case token authentication is wished instead, it could be implemented with 
a gem [https://github.com/lynndylanhurley/devise_token_auth devise_token_auth].

It supports multiple front end technologies, for example angular2-token.

This gem is configured similar to the devise gem itself. It also requires
omniauth as a dependency.

    # token-based authentication
    gem 'devise_token_auth'
    gem 'omniauth'

Then a route is defined:

    mount_devise_token_auth_for 'User', at: 'auth'

And the User model is modified accordingly.

These actions can be done with one command:
    
    rails g devise_token_auth:install [USER_CLASS] [MOUNT_PATH]

You may need to edit the generated migration to avoid unnecessary fields
and/or field duplication depending on your use case.

Note: when you use  only token authentication,  there is no more need in CSRF protection in controllers. If you use both ways: cookies and tokens, the paths where cookies are used for authentication still must be protected from forgery!


There is an OWASP [[Authentication Cheat Sheet]].

== Insecure Direct Object Reference or Forceful Browsing == 

By default, Ruby on Rails apps use a RESTful uri structure.  That means that paths are often intuitive and guessable.  To protect against a user trying to access or modify data that belongs to another user, it is important to specifically control actions.  Out of the gate on a vanilla Rails application, there is no such built in protection.  It is possible to do this by hand at the controller level.  

It is also possible, and probably recommended, to consider resource-based access control libraries such as [https://github.com/CanCanCommunity/cancancan cancancan] (cancan replacement) or [https://github.com/elabs/pundit pundit]to do this. This ensures that all operations on a database object are authorized by the business logic of the application. 

More general information about this class of vulnerability is in the [https://www.owasp.org/index.php/Top_10_2010-A4-Insecure_Direct_Object_References OWASP Top 10 Page].

== CSRF (Cross Site Request Forgery) ==

Ruby on Rails has specific, built in support for CSRF tokens.  To enable it, or ensure that it is enabled, find the base ApplicationController and look for a directive such as the following:

    <syntaxhighlight lang="ruby" line='line'>
    class ApplicationController < ActionController::Base
        protect_from_forgery
    </syntaxhighlight>

Note that the syntax for this type of control includes a way to add exceptions.  Exceptions may be useful for API’s or other reasons - but should be reviewed and consciously included.  In the example below, the Rails ProjectController will not provide CSRF protection for the show method.

   <syntaxhighlight lang="ruby" line='line'>
   class ProjectController < ApplicationController
       protect_from_forgery :except => :show
   </syntaxhighlight>

Also note that by default Rails does not provide CSRF protection for any HTTP GET 
request.

Note: if you use token authentication only, there is no need to protect from 
CSRF in controllers like this. If cookie-based authentication is used on some paths, then the protections is still required on them.

There is a top level OWASP page for [[Cross-Site Request Forgery (CSRF)]].

== Mass Assignment and Strong Parameters == 

Although the major issue with Mass Assignment has been fixed by default in base Rails specifically when generating new projects, it still applies to older and upgraded projects so it is important to understand the issue and to ensure that only attributes that are intended to be modifiable are exposed.

When working with a model, the attributes on the model will not be accessible to forms being posted unless a programmer explicitly indicates that:

    <syntaxhighlight lang="ruby" line='line'>
    class Project < ActiveRecord::Base
        attr_accessible :name, :admin
    end
    </syntaxhighlight>

With the admin attribute accessible based on the example above, the following could work:

    curl -d “project[name]=triage&project[admin]=1” host:port/projects

Review accessible attributes to ensure that they should be accessible.  If you are working in Rails < 3.2.3 you should ensure that your attributes are whitelisted with the following:

    <syntaxhighlight lang="ruby" line='line'>
    config.active_record.whitelist_attributes = true
    </syntaxhighlight>

In Rails 4.0 strong parameters will be the recommended approach for handling attribute visibility. It is also possible to use the strong_parameters gem with Rails 3.x, and the strong_parameters_rails2 gem for Rails 2.3.x applications.

== Redirects and Forwards == 

Web applications often require the ability to dynamically redirect users based on client-supplied data. To clarify, dynamic redirection usually entails the client including a URL in a parameter within a request to the application. Once received by the application, the user is redirected to the URL specified in the request. For example:

http://www.example.com/redirect?url=http://www.example_commerce_site.com/checkout

The above request would redirect the user to http://www.example.com/checkout.  The security concern associated with this functionality is leveraging an organization’s trusted brand to phish users and trick them into visiting a malicious site, in our example, “badhacker.com”.  Example:

http://www.example.com/redirect?url=http://badhacker.com

The most basic, but restrictive protection is to use the :only_path option. Setting this to true will essentially strip out any host information.  However, the :only_path option must be part of the first argument. If the first argument is not a hash table, then there is no way to pass in this option.  In the absence of a custom helper or whitelist, this is one approach that can work:
  
  <syntaxhighlight lang="ruby" line='line'>
  begin
    if path = URI.parse(params[:url]).path
      redirect_to path
    end
  rescue URI::InvalidURIError
    redirect_to '/'
  end
  </syntaxhighlight>

If matching user input against a list of approved sites or TLDs against regular expression is a must, it makes sense to leverage a library such as URI.parse() to obtain the host and then take the host value and match it against regular expression patterns. Those regular expressions must, at a minimum, have anchors or there is a greater chance of an attacker bypassing the validation routine.

Example:

    <syntaxhighlight lang="ruby" line='line'>
    require ‘uri’
    host = URI.parse(“#{params[:url]}”).host
    validation_routine(host) if host    # this can be vulnerable to javascript://trusted.com/%0Aalert(0) so check .scheme and .port too
    def validation_routine(host)
        # Validation routine where we use  \A and \z as anchors *not* ^ and $
        # you could also check the host value against a whitelist
    end
    </syntaxhighlight>




Also blind redirecting to user input parameter can lead to XSS. Example:
   
    <syntaxhighlight lang="ruby" line='line'>
    redirect_to params[:to]
    </syntaxhighlight>
    
    http://example.com/redirect?to[status]=200&to[protocol]=javascript:alert(0)//

The obvious fix for this type of vulnerability is to restrict to specific Top-Level Domains (TLDs), statically define specific sites, or map a key to it’s value. Example:

    <syntaxhighlight lang="ruby" line='line'>
    ACCEPTABLE_URLS = {
        ‘our_app_1’ => “https://www.example_commerce_site.com/checkout”,
        ‘our_app_2’ => “https://www.example_user_site.com/change_settings”
    }
    </syntaxhighlight>

http://www.example.com/redirect?url=our_app_1

   <syntaxhighlight lang="ruby" line='line'>
   def redirect
       url = ACCEPTABLE_URLS[“#{params[:url]}”]
       redirect_to url if url
   end
   </syntaxhighlight>

There is a more general OWASP resource about [[Unvalidated Redirects and Forwards Cheat Sheet|unvalidated redirects and forwards]].

== Dynamic Render Paths == 

In Rails, controller actions and views can dynamically determine which view or partial to render by calling the “render” method. If user input is used in or for the template name, an attacker could cause the application to render an arbitrary view, such as an administrative page.

Care should be taken when using user input to determine which view to render. If possible, avoid any user input in the name or path to the view.

== Cross Origin Resource Sharing ==

Occasionally, a need arises to share resources with another domain. For example, a file-upload function that sends data via an AJAX request to another domain. In these cases, the same-origin rules followed by web browsers must be bent. Modern browsers, in compliance with HTML5 standards, will allow this to occur but in order to do this; a couple precautions must be taken.

When using a nonstandard HTTP construct, such as an atypical Content-Type header, for example, the following applies:

The receiving site should whitelist only those domains allowed to make such requests as well as set the Access-Control-Allow-Origin header in both the response to the OPTIONS request and POST request. This is because the OPTIONS request is sent first, in order to determine if the remote or receiving site allows the requesting domain. Next, a second request, a POST request, is sent. Once again, the header must be set in order for the transaction to be shown as successful.

When standard HTTP constructs are used:

The request is sent and the browser, upon receiving a response, inspects the response headers in order to determine if the response can and should be processed.

Whitelist in Rails:

Gemfile
    gem 'rack-cors', :require => 'rack/cors'

config/application.rb
    module Sample
        class Application < Rails::Application
            config.middleware.use Rack::Cors do
                allow do
                    origins 'someserver.example.com'
                    resource %r{/users/\d+.json},
                        :headers => ['Origin', 'Accept', 'Content-Type'],
                        :methods => [:post, :get]
                end
            end
        end
    end

== Security-related headers ==

To set a header value, simply access the response.headers object as a hash inside your controller (often in a before/after_filter).

  response.headers['X-header-name'] = 'value'

'''Rails 4''' provides the "default_headers" functionality that will automatically apply the values supplied. This works for most headers in almost all cases.

  ActionDispatch::Response.default_headers = {	  	
    'X-Frame-Options' => 'SAMEORIGIN', 	
    'X-Content-Type-Options' => 'nosniff',	  	
    'X-XSS-Protection' => '1;'
  }

Strict transport security is a special case, it is set in an environment file (e.g. production.rb)

  config.force_ssl = true

For those not on the edge, there is a library ([https://github.com/twitter/secureheaders secure_headers]) for the same behavior with content security policy abstraction provided. It will automatically apply logic based on the user agent to produce a concise set of headers.

== Business Logic Bugs ==

Any application in any technology can contain business logic errors that result in security bugs.  Business logic bugs are difficult to impossible to detect using automated tools.  The best ways to prevent business logic security bugs are to do code review, pair program and write unit tests.

== Attack Surface == 

Generally speaking, Rails avoids open redirect and path traversal types of vulnerabilities because of its /config/routes.rb file which dictates what URL’s should be accessible and handled by which controllers.  The routes file is a great place to look when thinking about the scope of the attack surface.  An example might be as follows:

    match ':controller(/:action(/:id(.:format)))' # this is an example of what NOT to do

In this case, this route allows any public method on any controller to be called as an action.  As a developer, you want to make sure that users can only reach the controller methods intended and in the way intended.

== Sensitive Files == 

Many Ruby on Rails apps are open source and hosted on publicly available source code repositories.  Whether that is the case or the code is committed to a corporate source control system, there are certain files that should be either excluded or carefully managed.

    /config/database.yml                 -  May contain production credentials.
    /config/initializers/secret_token.rb -  Contains a secret used to hash session cookie.
    /db/seeds.rb                         -  May contain seed data including bootstrap admin user.
    /db/development.sqlite3              -  May contain real data. 


== Encryption == 

Rails uses OS encryption.  Generally speaking, it is always a bad idea to write your own encryption.

Devise by default uses bcrypt for password hashing, which is an appropriate solution.  Typically, the following config causes the 10 stretches for production:  /config/initializers/devise.rb

    config.stretches = Rails.env.test? ? 1 : 10

= Updating Rails and Having a Process for Updating Dependencies = 

In early 2013, a number of critical vulnerabilities were identified in the Rails Framework.  Organizations that had fallen behind current versions had more trouble updating and harder decisions along the way, including patching the source code for the framework itself.

An additional concern with Ruby applications in general is that most libraries (gems) are not signed by their authors.  It is literally impossible to build a Rails based project with libraries that come from trusted sources.  One good practice might be to audit the gems you are using.

In general, it is important to have a process for updating dependencies.  An example process might define three mechanisms for triggering an update of response: 
* Every month/quarter dependencies in general are updated.
* Every week important security vulnerabilities are taken into account and potentially trigger an update.
* In EXCEPTIONAL conditions, emergency updates may need to be applied.

= Tools =

Use [http://brakemanscanner.org/ brakeman], an open source code analysis tool for Rails applications, to identify many potential issues.  It will not necessarily produce comprehensive security findings, but it can find easily exposed issues.  A great way to see potential issues in Rails is to review the brakeman documentation of warning types.

There are emerging tools that can be used to track security issues in dependency sets, like https://appcanary.com/ and https://gemnasium.com/.

Another area of tooling is the security testing tool [http://gauntlt.org Gauntlt] which is built on cucumber and uses gherkin syntax to define attack files.

Launched in May 2013 and very similiar to brakeman scanner, the [https://github.com/thesp0nge/dawnscanner dawnscanner] rubygem is a static analyzer for security issues that work with Rails, Sinatra and Padrino web applications. Version 0.60 has more than 30 ruby specific CVE security checks and future releases custom checks against Cross Site Scripting and SQL Injections will be added.

= Authors and Primary Editors = 
Matt Konda - mkonda [at] jemurai.com<br/>
Neil Matatall neil [at] matatall.com<br/>
Ken Johnson cktricky [at] gmail.com<br/>
Justin Collins justin [at] presidentbeef.com<br/>
Jon Rose - jrose400 [at] gmail.com<br/>
Lance Vaughn - lance [at] cabforward.com<br/>
Jon Claudius - jonathan.claudius [at] gmail.com<br/>
Jim Manico jim [at] owasp.org<br/>
Aaron Bedra aaron [at] aaronbedra.com<br/>
Egor Homakov homakov [at] gmail.com<br/>
Zaur Molotnikov qutorial [at] gmail.com [[User:ZaurMolotnikov|🡕 profile]]<br/>

= Related Articles and References = 

* [http://guides.rubyonrails.org/security.html The Official Rails Security Guide]
* [https://www.owasp.org/index.php/Category:OWASP_Ruby_on_Rails_Security_Guide_V2 OWASP Ruby on Rails Security Guide]
* [http://code.google.com/p/ruby-security/wiki/Guide The Ruby Security Reviewers Guide]
* [https://groups.google.com/forum/?fromgroups#!forum/rubyonrails-security The Ruby on Rails Security Mailing List]
* [http://blog.codeclimate.com/blog/2013/03/27/rails-insecure-defaults/ Rails Insecure Defaults]

= Other Cheatsheets =

{{Cheatsheet_Navigation_Body}}

|}

[[Category:Cheatsheets]]