puppet-sec-lint 0.5.14 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f5d30d4bf9e32338bf3c81fa619d6cb6560870343d01a62905282ac5724d6e
-  data.tar.gz: d6d63ef87f2df9654f2edac1a1b75f3525b2bc514e46608f2990923b830a5134
+  metadata.gz: 0ed39e8fd69a0dd1d3091aaee274f88cc192e973ef2b2cd21076a86aa21f6712
+  data.tar.gz: 9483297393e0eaebe4551b037d87260552c0e26b2b76d77dd9db14485c0a197c
 SHA512:
-  metadata.gz: 90e1f2fddbc2d97ad919d54e98870650f4d56b944676ff8f115a29b84395ae9413770d4985f45510fd77a5de46b5a4377b404974eb8265aca8a18087a9392d83
-  data.tar.gz: 88312bf0a323156a1eb265700079cacf07c19e92c190d6b497acf28e2b08a92b7cb56ec7e656649ffff5865dfb7b08f546b0dc90f72fcba13fbf8e6fe2e8cd43
+  metadata.gz: c759dca11c5156be203bafff3ccb26dfcc02a10936a5157b061dabdb42de8689ddc69e79865a999e792c704712cbd95757f383ee1afac33e75b326ad1dbeb9dd
+  data.tar.gz: 49d80107d0ab6d01c73fa24b6482cd7a483f7bf0ec049e860b12b67a27aa69293df98b00bf24cd36def138d3bce3884c4d2b87421b2162f7bec90251d957bf11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    puppet-sec-lint (0.5.14)
+    puppet-sec-lint (1.0.0)
       inifile (~> 3.0.0)
       launchy (~> 2.5.0)
       logger (~> 1.4.3)

data/README.md

@@ -50,20 +50,52 @@ puppet-sec-lint -c
 
 ## Development
 
-### Development of new rules
-
 The linter was built on top of a modular architecture, which means that new customizable rules can be added fairly easy facing the discovery of new scenarios and vulnerabilities.
 
-<!--
-(add instructions on how to clone, build and run tool)
+### Cloning and running 
+
+To add new functionality to the tool, start by cloning the repository into a folder.
+To run the software locally, run the executable **exe/puppet-sec-lint** from a command line.
+
+### Adding new rules
+
+To add a new rule, the easiest way is to duplicate the file of an existing rule inside the **lib/rules** folder. Taking the *Admin By Default* rule as an example, here is everything that can be changed and customized.
+
+![puppet-sec-lint rule](docs/images/puppet-sec-lint_rule.png)
+
+#### Naming
+
+The class should have an unique and meaningful name, both at the class name itself and the property @Name (that's what's displayed in the Configurations page). It should also be derived from the **Rule** class.
+
+#### Token analysis
+
+Each rule works by running the **AnalyzeTokens** method, receiving a list of tokens (that represent the entire code of the file being analyzed) and after analyzing everything, it should return a list of results (each result is a vulnerability found represented by the **Sin** class). Adding new types of vulnerabilities can be done by adding new elements to the **SinType** class.
+
+#### Configurations
+
+To add configurable elements to the class, simply create new instances of the child classes of the **Configuration** class, as exemplified in the above rule. The constructor takes as arguments the title and description (to be shown in the configurations page) and the initial default value (before the user modifies the application settings).
+
+All configurations should then be added to the @configurations array.
+
+The current types of configurations available (children of the **Configuration** class) are:
+
+* Boolean
+  
+  ![puppet-sec-lint configuration_bool](docs/images/puppet-sec-lint_configuration_bool.png)
+* List of elements
+  
+  ![puppet-sec-lint configuration_list](docs/images/puppet-sec-lint_configuration_list.png)
+* Regular Expression
+  
+  ![puppet-sec-lint configuration_regex](docs/images/puppet-sec-lint_configuration_regex.png)
 
-(add instructions on where and how to add new rule and configurations)
--->
+#### Add rule to rule engine
 
-<!--After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The final step is to ensure that the Rule Engine can detect and run the rule everytime an analysis is performed. As such, in the **lib/rule_engine.rb** file, import the newly created rule and add it to the @rules array.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).-->
+---
 
+After following these steps, the rule should then be automatically run everytime an analysis is performed. Also, the configurations now show up automatically in the configurations page, giving the user the possibility to customize its values. 
 
 ## Contributing
 

data/docs/admin-by-default.md

@@ -24,4 +24,8 @@ Any account with the power to do everything in the system is a very dangerous si
 
 ## How to avoid it?
 
-Accounts should always be setup up with the [Principle of least privilege](https://us-cert.cisa.gov/bsi/articles/knowledge/principles/least-privilege) in mind, meaning that all accounts should only get the permissions strictly necessary to perform their required tasks during the minimum amount of time possible. This severely limits the exposure to accidental errors and also to malicious attackers.
+Accounts should always be setup up with the [Principle of least privilege](https://us-cert.cisa.gov/bsi/articles/knowledge/principles/least-privilege) in mind, meaning that all accounts should only get the permissions strictly necessary to perform their required tasks during the minimum amount of time possible. This severely limits the exposure to accidental errors and also to malicious attackers.
+
+## More related information
+
+* [CWE-250: Execution with Unnecessary Privileges](https://cwe.mitre.org/data/definitions/250.html)

data/docs/cyrillic-homograph-attack.md

@@ -37,4 +37,8 @@ This malicious domain on a Puppet manifest can point to a fake package repositor
 After the tool detects the presence of Cyrillic characters on a URL, the best course of action is to replace all Cyrillic characters with their Latin counterparts, as these characters are very rarely used in legitimate domains.
 Then, check if the domain is well written (subtle misspellings with similar letters are very common in these kinds of attacks).
 
-To better ensure that the domain is actually the correct one, the URL can also be copied from a trusted source.
+To better ensure that the domain is actually the correct one, the URL can also be copied from a trusted source.
+
+## More related information
+
+* [CWE-1007: Insufficient Visual Distinction of Homoglyphs Presented to User](https://cwe.mitre.org/data/definitions/1007.html)

data/docs/empty-password.md

@@ -24,4 +24,8 @@ An attacker looking to gain access to an account my try a couple of different ge
 
 ## How to avoid it?
 
-Secure software systems should have a decent password policy that prevents, among other types, empty passwords. This means that it's very likely for the Puppet manifest to fail as the password would be rejected. But even if the target software accepts empty passwords, a long and hard to guess password is always a much safer option against malicious attacks.
+Secure software systems should have a decent password policy that prevents, among other types, empty passwords. This means that it's very likely for the Puppet manifest to fail as the password would be rejected. But even if the target software accepts empty passwords, a long and hard to guess password is always a much safer option against malicious attacks.
+
+## More related information
+
+* [CWE-258: Empty Password in Configuration File](https://cwe.mitre.org/data/definitions/258.html)

data/docs/hard-coded-credentials.md

@@ -77,4 +77,9 @@ file { '/etc/mysql/server-key.pem':
   ensure  => file,
   content => hiera("privatekey"),
 }
-```
+```
+
+## More related information
+
+* [CWE-259: Use of Hard-coded Password](https://cwe.mitre.org/data/definitions/259.html)
+* [CWE-798: Use of Hard-coded Credentials](https://cwe.mitre.org/data/definitions/798.html)

data/docs/http-without-tls.md

@@ -39,4 +39,8 @@ The attacker can then use this information to attack his victim, by logging in a
 
 ## How to avoid it?
 
-All connections to internet addresses or made available to the public by a service configured with a Puppet manifest must use some kind of secure protocol, to ensure the confidentiality, authenticity and integrity of all data exchanged. Making an HTTPS connection is the easiest way to do this and it's also the recommended way of addressing this security vulnerability. In some cases, if the transferred information is verified afterwards by an hashing algorithm, like packages transferred from a repository, then this solution can be considered optional.
+All connections to internet addresses or made available to the public by a service configured with a Puppet manifest must use some kind of secure protocol, to ensure the confidentiality, authenticity and integrity of all data exchanged. Making an HTTPS connection is the easiest way to do this and it's also the recommended way of addressing this security vulnerability. In some cases, if the transferred information is verified afterwards by an hashing algorithm, like packages transferred from a repository, then this solution can be considered optional.
+
+## More related information
+
+* [CWE-319: Cleartext Transmission of Sensitive Information](https://cwe.mitre.org/data/definitions/319.html)

data/docs/invalid-ip-addr-binding.md

@@ -28,4 +28,8 @@ A server or service that's open to all kinds of connections it's more exposed to
 
 ## How to avoid it?
 
-Properly configuring binding addresses means that the server should only accept connections from trusted networks known to use the service. This ensures a greater level of control and also protection, as an attacker would know have an extra obstacle in trying to gain access first to one of those networks.
+Properly configuring binding addresses means that the server should only accept connections from trusted networks known to use the service. This ensures a greater level of control and also protection, as an attacker would know have an extra obstacle in trying to gain access first to one of those networks.
+
+## More related information
+
+* [CWE-284: Improper Access Control](https://cwe.mitre.org/data/definitions/284.html)

data/docs/suspicious-comments.md

@@ -0,0 +1,31 @@
+---
+title: Suspicious Comments
+permalink: /suspicious-comments/
+layout: default
+---
+
+# Suspicious Comments
+
+## What are they?
+
+Suspicious comments are all comments left in a release of a Puppet Manifest that might suggest the existence of bugs, missing security functionalities or other weaknesses.
+
+
+### Example
+```puppet
+# TODO: switch password from weak hash to sha256
+$key = md5("${client_name} ${client_ip} ${client_seed}")
+```
+This comment immediately tells that developers are aware of the weakness of using a compromised hashing algorithm, but still hadn't made the necessary fix.
+
+## How can it be exploited?
+
+In the previous example, the presence of the comment immediately draws the attention of a malicious hacker who might have gained access to the code repository. By stating the portion of code that is considered insecure, it tells to an attacker exactly where to look for unpatched vulnerabilities. In this case, he could start working on ways to break the weak hashing algorithm.
+
+## How to avoid it?
+
+All comments indicating to be implemented features or non-resolved security issues should be erased, as they pose a very serious threat by gaining the attackers attention. Instead, proper and secure defect management solutions should be used. As a plus, the code stays clean and easy to read.
+
+## More related information
+
+* [CWE-546: Suspicious Comment](https://cwe.mitre.org/data/definitions/546.html)

data/docs/weak-crypto-algorithm.md

@@ -28,4 +28,9 @@ An attacker who was able to gain access to a server and steal the hashes from al
 
 ## How to avoid it?
 
-If the Puppet manifest is being used to generate hashes for passwords or important data, using a more secure algorithm like SHA256 is very advisable as it avoids exposure to the risks mentioned above, ensuring that the algorithm actually performs what's intended to.
+If the Puppet manifest is being used to generate hashes for passwords or important data, using a more secure algorithm like SHA256 is very advisable as it avoids exposure to the risks mentioned above, ensuring that the algorithm actually performs what's intended to.
+
+## More related information
+
+* [CWE-326: Inadequate Encryption Strength](https://cwe.mitre.org/data/definitions/326.html)
+* [CWE-327: Use of a Broken or Risky Cryptographic Algorithm](https://cwe.mitre.org/data/definitions/327.html)

data/exe/puppet-sec-lint

@@ -70,6 +70,8 @@ puts "Release v#{PuppetSecLint::VERSION}       #{PuppetSecLint::AUTHOR}      #{P
 
 puts "\n"
 
+STDOUT.flush
+
 if not ARGV[0].nil?
   if File.file?(ARGV[0].to_s) && File.extname(ARGV[0].to_s) == '.pp'
     analyze_file(ARGV[0].to_s)
@@ -102,6 +104,7 @@ if ARGV[0].nil? || options[:configurations]
   else
     puts "\nLinter configurations page available at #{conf_page_url}\n\n"
     puts "-----------------------------------------------------------------------"
+    STDOUT.flush
   end
 
   linter_server.join

data/lib/facades/configuration_page_facade.rb

@@ -75,8 +75,7 @@ class ConfigurationPageFacade
           configuration.value = new_conf[configuration.id].split(/\r?\n/).delete_if(&:empty?)
 
         when DisplayField[:RegexBox]
-          configuration.value = Regexp.new new_conf[configuration.id]
-
+          configuration.value = if new_conf[configuration.id].empty? then new_conf[configuration.id] else Regexp.new new_conf[configuration.id] end
         else
           configuration.value = new_conf[configuration.id]
         end

data/lib/puppet-sec-lint/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PuppetSecLint
-  VERSION = "0.5.14"
+  VERSION = "1.0.0"
   YEAR = "2021"
   AUTHOR = "TQRG"
 end

data/lib/rules/no_http_rule.rb

@@ -22,7 +22,7 @@ class NoHTTPRule < Rule
 
     ptokens = self.filter_resources(tokens, @resources_conf.value)
     ctokens = self.filter_variables(ptokens, @keywords_conf.value) #TODO: It's working upside down
-    if @whitelist_conf.value
+    if not @whitelist_conf.value.to_s.empty?
       wtokens = self.filter_whitelist(ctokens, @whitelist_conf.value)
     else
       wtokens = ptokens

data/lib/settings.ini

@@ -7,10 +7,10 @@ HardCodedCredentialsRule-regular_expression_of_words_not_present_in_credentials
 
 [NoHTTPRule]
 NoHTTPRule-enable_configuration = true
-NoHTTPRule-list_of_resources_that_can_use_http = apt::source,::apt::source,wget::fetch,yumrepo,yum::,aptly::mirror,util::system_package,yum::managed_yumrepo
+NoHTTPRule-list_of_resources_that_can_use_http = apt::source,::apt::source,wget::fetch,yumrepo,yum::,aptly::mirror,util::system_package,yum::managed_yumrepo,apt::repository
 NoHTTPRule-list_of_keywords_for_urls = backport,key,download,uri,mirror
 NoHTTPRule-regular_expression_of_a_normal_http_address = (?-mix:^http:\/\/.+)
-NoHTTPRule-http_address_whitelist = (?-mix:^(127.0.0.1))
+NoHTTPRule-http_address_whitelist = 
 
 [AdminByDefaultRule]
 AdminByDefaultRule-enable_configuration = true

data/puppet-sec-lint.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Linter built to detect potential security vulnerabilities in Puppet manifests code. It also offers integration with Visual Studio Code https://marketplace.visualstudio.com/items?itemName=tiago1998.puppet-sec-lint-vscode"
   spec.homepage      = "https://github.com/TiagoR98/puppet-sec-lint"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-sec-lint
 version: !ruby/object:Gem::Version
-  version: 0.5.14
+  version: 1.0.0
 platform: ruby
 authors:
 - Tiago Ribeiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -173,11 +173,16 @@ files:
 - docs/empty-password.md
 - docs/hard-coded-credentials.md
 - docs/http-without-tls.md
+- docs/images/puppet-sec-lint_configuration_bool.png
+- docs/images/puppet-sec-lint_configuration_list.png
+- docs/images/puppet-sec-lint_configuration_regex.png
 - docs/images/puppet-sec-lint_configurations.png
 - docs/images/puppet-sec-lint_console.png
+- docs/images/puppet-sec-lint_rule.png
 - docs/images/puppet-sec-lint_vscode.png
 - docs/index.md
 - docs/invalid-ip-addr-binding.md
+- docs/suspicious-comments.md
 - docs/weak-crypto-algorithm.md
 - exe/puppet-sec-lint
 - lib/configurations/boolean_configuration.rb
@@ -223,7 +228,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="