solium-plugin-security

The official Security Plugin for Solium

This Plugin provides security-focused lint rules for Solium.

The rules have been taken from Consensys' Recommended Smart Contract Practices and Solium's Rule Wishlist.

Installation

NOTE: If you're using Solium v1.0.1 or above, this plugin comes pre-installed as a local dependency and you can skip this section.

npm install -g solium-plugin-security

Usage

NOTE: If you've installed Solium v1.0.1 or above and created soliumrc.json using solium --init, you can skip this step since solium automatically applies the security plugin for you.

Add security to your soliumrc.json's plugins array. Your configuration file should look like:

{
    "extends": "solium:all",
    "plugins": ["security"],
    "rules": {
        ...
    }
}

Developer Setup

git clone <URL-of-this-repo> cd solium-plugin-security npm install --dev npm test

List of rules

Below are the rules supplied by this plugin and the information on passing options to them and their auto-fixing capabilities.

Name	Description	Options	Defaults	Fixes
no-throw	Discourage use of 'throw' statement for error flagging.			YES
no-sha3	Encourage use of 'keccak256()' over 'sha3()' function.			YES
no-tx-origin	Discourage use of 'tx.origin' global variable.
no-low-level-calls	Discourage the use of low-level functions - call(), callcode() & delegatecall().	List of functions to warn against	["call", "callcode", "delegatecall"]
no-inline-assembly	Discourage use of inline assembly.
no-call-value	Discourage use of .call.value()()
no-block-members	Discourage use of members 'blockhash' & 'timestamp' (and alias 'now') of 'block' global variable	List of members to warn against	["blockhash", "timestamp"]
enforce-explicit-visibility	Encourage user to explicitly specify visibility of function			YES

An example soliumrc.json configuring and applying this plugin is:

{
    "plugins": ["security"],
    "rules": {
        "some-other-solium-rule": 1,
        "security/no-low-level-calls": ["error", ["call", "delegatecall"]],
        "security/no-block-members": [1, ["timestamp"]],
        "security/no-throw": "off"
    }
}

This tells solium to apply the 3 security/ rules with special configuration provided and apply the remaining rules of the plugin with their default configurations. If you want to disable a plugin rule, you have to explicitly disable it inside rules.

Lint normally using solium -d contracts/ or solium -d contracts/ --fix to apply fixes as well.

Roadmap

• Add automated tests
• Add more security rules

Security rules to be implemented

• no-multiple-send-calls
• check-send-result

...And many more from the sources listed above