Mass Assignment Cheat Sheet¶

Software frameworks sometime allow developers to automatically bind HTTP request parameters into program code variables or objects to make using that framework easier on developers. This can sometimes cause harm.

Attackers can sometimes use this methodology to create new parameters that the developer never intended which in turn creates or overwrites new variable or objects in program code that was not intended.

This is called a Mass Assignment vulnerability.

Alternative Names¶

Depending on the language/framework in question, this vulnerability can have several alternative names:

Mass Assignment: Ruby on Rails, NodeJS.

Ruby on Rails, NodeJS. Autobinding: Spring MVC, ASP NET MVC.

Spring MVC, ASP NET MVC. Object injection: PHP.

Suppose there is a form for editing a user's account information:

< form > < input name = "userid" type = "text" > < input name = "password" type = "text" > < input name = "email" text = "text" > < input type = "submit" > </ form >

Here is the object that the form is binding to:

public class User { private String userid ; private String password ; private String email ; private boolean isAdmin ; //Getters & Setters }

Here is the controller handling the request:

@RequestMapping ( value = "/addUser" , method = RequestMethod . POST ) public String submit ( User user ) { userService . add ( user ); return "successPage" ; }

Here is the typical request:

And here is the exploit in which we set the value of the attribute isAdmin of the instance of the class User :

This functionality becomes exploitable when:

Attacker can guess common sensitive fields.

Attacker has access to source code and can review the models for sensitive fields.

AND the object with sensitive fields has an empty constructor.

GitHub case study¶

In 2012, GitHub was hacked using mass assignment. A user was able to upload his public key to any organization and thus make any subsequent changes in their repositories. GitHub's Blog Post.

Whitelist the bindable, non-sensitive fields.

Blacklist the non-bindable, sensitive fields.

Use Data Transfer Objects (DTOs).

General Solutions¶

An architectural approach is to create Data Transfer Objects and avoid binding input directly to domain objects. Only the fields that are meant to be editable by the user are included in the DTO.

public class UserRegistrationFormDTO { private String userid ; private String password ; private String email ; //NOTE: isAdmin field is not present //Getters & Setters }

Language & Framework specific solutions¶

Spring MVC¶

@Controller public class UserController { @InitBinder public void initBinder ( WebDataBinder binder , WebRequest request ) { binder . setAllowedFields ( [ "userid" , "password" , "email" ] ); } ... }

Take a look here for the documentation.

@Controller public class UserController { @InitBinder public void initBinder ( WebDataBinder binder , WebRequest request ) { binder . setDisallowedFields ( [ "isAdmin" ] ); } ... }

Take a look here for the documentation.

NodeJS + Mongoose¶

var UserSchema = new mongoose . Schema ({ userid : String , password : String , email : String , isAdmin : Boolean , }); UserSchema . statics = { User . userCreateSafeFields : [ 'userid' , 'password' , 'email' ] }; var User = mongoose . model ( 'User' , UserSchema ); _ = require ( 'underscore' ); var user = new User ( _ . pick ( req . body , User . userCreateSafeFields ));

Take a look here for the documentation.

var massAssign = require ( 'mongoose-mass-assign' ); var UserSchema = new mongoose . Schema ({ userid : String , password : String , email : String , isAdmin : { type : Boolean , protect : true , default : false } }); UserSchema . plugin ( massAssign ); var User = mongoose . model ( 'User' , UserSchema ); /** Static method, useful for creation **/ var user = User . massAssign ( req . body ); /** Instance method, useful for updating**/ var user = new User ; user . massAssign ( req . body ); /** Static massUpdate method **/ var input = { userid : 'bhelx' , isAdmin : 'true' }; User . update ({ '_id' : someId }, { $set : User . massUpdate ( input ) }, console . log );

Take a look here for the documentation.

Ruby On Rails¶

Take a look here for the documentation.

Take a look here for the documentation.

ASP NET¶

Take a look here for the documentation.

PHP Laravel + Eloquent¶

<?php namespace App ; use Illuminate\Database\Eloquent\Model ; class User extends Model { private $userid ; private $password ; private $email ; private $isAdmin ; protected $fillable = array ( 'userid' , 'password' , 'email' ); }

Take a look here for the documentation.

<?php namespace App ; use Illuminate\Database\Eloquent\Model ; class User extends Model { private $userid ; private $password ; private $email ; private $isAdmin ; protected $guarded = array ( 'isAdmin' ); }

Take a look here for the documentation.

Take a look here for the documentation.

Take a look here for the documentation.

Jackson (JSON Object Mapper)¶

Take a look here and here for the documentation.

GSON (JSON Object Mapper)¶

Take a look here and here for the document.

Take a look here for the documentation.

Flexjson (JSON Object Mapper)¶

Take a look here for the documentation.

References and future reading¶