puppet-sec-lint 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eaf96b63a536fffdcad382d9cdd36aeb315217f9b3ddac70de1858bc898cd793
+  data.tar.gz: d4a15a04b437dd4e9eca7478a99094e5c3c3bf1ca59e082dbe05e1f037b910fe
+SHA512:
+  metadata.gz: f598081277fc495c326dbc814483f39f5df0975a5e55055386664b5daa3dd97577a4701cb5bf40fb589b4bf0b22285b4226de83ae97f206c8372e014da4e6515
+  data.tar.gz: f02c510e8a2017bb28a73278676a043ae2b094837288711e5e54d2a4f29bdc34ec5b47cebd0b0a2f28d3df79818fe88b04b0c3b219e132b99d7bee6d7d39513d

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/puppet-sec-lint.iml" filepath="$PROJECT_DIR$/.idea/puppet-sec-lint.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/puppet-sec-lint.iml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.3, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="daemons (v1.3.1, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="eventmachine (v1.2.7, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="inifile (v3.0.0, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.14.4, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="puppet-lint (v2.4.2, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rack (v2.2.3, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.3, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thin (v1.8.0, RVM: ruby-3.0.0 [global]) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build puppet-sec-lint-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install puppet-sec-lint-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install puppet-sec-lint-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.0 and build and push puppet-sec-lint-0.1.0.gem to TODO: Set to 'http://mygemserver.com'" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run tests" fullCommand="test" id="test" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TiagoJose.Ribeiro@ctw.bmwgroup.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in puppet-sec-lint.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "puppet-lint"
+
+gem "rack"
+
+gem 'thin'
+
+gem 'inifile'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    puppet-sec-lint (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    daemons (1.3.1)
+    eventmachine (1.2.7)
+    inifile (3.0.0)
+    minitest (5.14.4)
+    puppet-lint (2.4.2)
+    rack (2.2.3)
+    rake (13.0.3)
+    thin (1.8.0)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  inifile
+  minitest (~> 5.0)
+  puppet-lint
+  puppet-sec-lint!
+  rack
+  rake (~> 13.0)
+  thin
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tiago Ribeiro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Puppet::Sec::Lint
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/puppet/sec/lint`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppet-sec-lint'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install puppet-sec-lint
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/puppet-sec-lint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/puppet-sec-lint/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Puppet::Sec::Lint project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/puppet-sec-lint/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "puppet-sec-lint"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/puppet-sec-lint

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/rule_engine'
+require 'json'
+require 'optparse'
+require 'optparse/uri'
+require_relative '../lib/visitors/configuration_visitor'
+require_relative '../lib/facades/configuration_file_facade'
+require_relative '../lib/language_server'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: puppet-sec-lint [options]"
+
+  opts.on("-f", "--file FILE",URI, "Path of puppet file to be analyzed") do |file|
+    options[:file] = file
+  end
+end.parse!
+
+if options[:file].nil?
+  LanguageServer
+end
+
+ConfigurationVisitor.GenerateIDs
+ConfigurationFileFacade.LoadConfigurations
+
+File.open(options[:file].to_s, 'rb:UTF-8') do |f|
+  code = f.read
+
+  result = RuleEngine.analyzeDocument(code)
+
+  result.each do |sin|
+    puts sin.ToString
+  end
+end

data/lib/configurations/boolean_configuration.rb

@@ -0,0 +1,10 @@
+require_relative 'configuration'
+
+class BooleanConfiguration < Configuration
+
+  def initialize(name, value, description)
+    super
+    @displayfield=DisplayField[:CheckBox]
+  end
+
+end

data/lib/configurations/configuration.rb

@@ -0,0 +1,19 @@
+require 'securerandom'
+
+class Configuration
+  attr_accessor :name,:value,:description,:id,:displayfield
+
+  def initialize(name, value, description)
+    @name = name
+    @value = value
+    @description = description
+  end
+
+end
+
+DisplayField = {
+  TextBox: "textbox",
+  CheckBox: "checkbox",
+  NumericBox: "numericbox",
+  SelectBox: "selectbox"
+}

data/lib/configurations/list_configuration.rb

@@ -0,0 +1,9 @@
+require_relative 'configuration'
+
+class ListConfiguration < Configuration
+
+  def initialize(name, value, description)
+    super
+    @displayfield=DisplayField[:SelectBox]
+  end
+end

data/lib/facades/configuration_file_facade.rb

@@ -0,0 +1,43 @@
+require 'inifile'
+
+class ConfigurationFileFacade
+
+  def self.SaveConfigurations
+    @configurations_hash = ConfigurationVisitor.Visit
+
+    ini = IniFile.new( :filename => 'settings.ini', :encoding => 'UTF-8' )
+
+    @configurations_hash.each do |rule, configurations|
+      configurations.each do |configuration|
+        case configuration.displayfield
+        when DisplayField[:SelectBox]
+          ini[rule][configuration.id] = configuration.value.join(',')
+        else
+          ini[rule][configuration.id] = configuration.value
+        end
+      end
+    end
+
+    ini.save
+  end
+
+  def self.LoadConfigurations
+    @configurations_hash = ConfigurationVisitor.Visit
+
+    ini = IniFile.new( :filename => 'settings.ini')
+
+    @configurations_hash.each do |rule, configurations|
+      configurations.each do |configuration|
+        if(not ini[rule][configuration.id].nil?)
+          case configuration.displayfield
+          when DisplayField[:SelectBox]
+            configuration.value = ini[rule][configuration.id].split(',')
+          else
+            configuration.value = ini[rule][configuration.id]
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/facades/configuration_page_facade.rb

@@ -0,0 +1,83 @@
+require_relative '../visitors/configuration_visitor'
+
+class ConfigurationPageFacade
+
+  @configurations_hash=""
+
+  def self.AssemblePage
+    @configurations_hash = ConfigurationVisitor.Visit
+
+    final_html = self.Title
+    final_html += self.ConfigurationsForm
+    return final_html
+  end
+
+  def self.Title
+    return "<h1>Configurations Page</h1>\n"
+  end
+
+  def self.ConfigurationsForm
+    final_html = "<form action=\"/configuration\" method=\"post\">\n"
+    @configurations_hash.each do |rule, configurations|
+      final_html += self.RuleConfigurations(rule,configurations)
+    end
+    final_html += "<input type=\"submit\" value=\"Submit\">\n"
+    final_html += "</form>\n"
+
+    return final_html
+  end
+
+  def self.RuleConfigurations(rule,configurations)
+    final_html = "<h2>#{rule.name}</h2>\n"
+
+    configurations.each do |configuration|
+      final_html += self.Input(configuration)
+    end
+
+    return final_html
+  end
+
+  def self.Input(configuration)
+    return_value = "<label for=\"#{configuration.class.name}\">#{configuration.name}:</label>\n"
+
+    case configuration.displayfield
+    when DisplayField[:CheckBox]
+      return_value += "<input type=\"checkbox\" id=\"#{configuration.id}\" name=\"#{configuration.id}\""+if configuration.value then "checked" else "" end+"><br>\n"
+
+    when DisplayField[:SelectBox]
+      return_value += "<br><textarea id=\"#{configuration.id}\" name=\"#{configuration.id}\" rows=\"#{configuration.value.length()+2}\">\n"
+      configuration.value.each do |option|
+        return_value+="#{option}\n"
+      end
+      return_value += "</textarea>"
+    end
+
+    return_value += "<p style=\"color:gray\">#{configuration.description}</p>\n<br>\n"
+
+    return return_value
+  end
+
+  def self.ApplyConfigurations(new_conf)
+    @configurations_hash.each do |rule, configurations|
+      configurations.each do |configuration|
+
+        case configuration.displayfield
+        when DisplayField[:CheckBox]
+          if new_conf.has_key?(configuration.id)
+            configuration.value = true
+          else
+            configuration.value = false
+          end
+
+        when DisplayField[:SelectBox]
+          configuration.value = new_conf[configuration.id].split(/\r?\n/).delete_if(&:empty?)
+        else
+          configuration.value = new_conf[configuration.id]
+        end
+
+      end
+    end
+  end
+
+  private_class_method :Title,:ConfigurationsForm, :RuleConfigurations, :Input
+end

data/lib/language_server.rb

@@ -0,0 +1,78 @@
+require "rack"
+require "thin"
+require 'json'
+require 'uri'
+require_relative 'rule_engine'
+require_relative 'visitors/configuration_visitor'
+require_relative 'facades/configuration_page_facade'
+require_relative 'facades/configuration_file_facade'
+
+class LanguageServer
+  ConfigurationVisitor.GenerateIDs
+  ConfigurationFileFacade.LoadConfigurations
+
+  def call(env)
+    req = Rack::Request.new(env)
+
+    case req.path
+    when "/"
+      if req.post?
+        process_analysis(req)
+      end
+    when "/configuration"
+      if req.post?
+        process_form(req)
+      elsif req.get?
+        configurations_page
+      end
+    end
+
+  end
+
+  def process_form(req)
+    new_conf = URI.decode_www_form(req.body.read)
+    new_conf_hash = Hash[new_conf.map {|key, value| [key, value]}]
+
+    ConfigurationPageFacade.ApplyConfigurations(new_conf_hash)
+    ConfigurationFileFacade.SaveConfigurations
+
+    return [200, { 'Content-Type' => 'text/plain' }, ["Changes saved successfully"]]
+  end
+
+  def process_analysis(req)
+    body = JSON.parse(req.body.read)
+
+    if body['documentContent']
+      code = body['documentContent']
+
+      result_json = []
+
+      result = RuleEngine.analyzeDocument(code) #convert to json
+
+      result.each do |sin|
+        result_json.append(JSON.generate({
+                             'name' => sin.type[:name],
+                             'message' => sin.type[:message],
+                             'recommendation' => sin.type[:recommendation],
+                             'begin_line' => sin.begin_line,
+                             'begin_char' => sin.begin_char,
+                             'end_line' => sin.end_line,
+                             'end_char' => sin.end_char
+                           }))
+      end
+
+      return [200, { 'Content-Type' => 'application/json' }, [result_json.to_json]]
+    end
+
+    [401, { 'Content-Type' => 'text/html' }, ['Invalid Request']]
+  end
+
+  def configurations_page
+    configuration_page = ConfigurationPageFacade.AssemblePage
+
+    return [200, { 'Content-Type' => 'text/html' }, [configuration_page]]
+  end
+
+end
+
+Rack::Handler::Thin.run(LanguageServer.new, :Port => 9292)

data/lib/lol.pp

@@ -0,0 +1,83 @@
+#class path_attribute {
+#  file { 'ssh_config_file':
+#    path    => '/etc/ssh/sshd_config',
+#    content => 'Bad path attribute, bad.',
+#  }
+#}
+
+# the following code addresses the bug: https://bugs.launchpad.net/keystone/+bug/1472285 .
+
+class consul_template::service (
+    $rpc_password                   = '{6ad470ec62b0511b63340dca2950d750181598efnHKvN1ge',
+    $admin_username = 'admin',
+    $password       = 'ceilometer',
+    $admin_password = 'admin',
+  ) {
+  exec { 'network-restart':
+    command        => 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDM release-runner key',
+    path           => '/usr/bin:/usr/sbin:/bin:/sbin',
+    refreshonly    => true,
+    vmware_md5     => 'LOL',
+    autho          => 'MD5',
+    cmd            => 'virsh secret-define --file ${secret_xml} && virsh secret-set-value --secret ${rbd_secret_uuid} --base64 $(ceph auth get-key client.${user})',
+    $auth_uri      => 'http://127.0.0.1:5000',
+    'bind_address' => '0.0.0.0',
+    password       => '',
+  }
+  case $::osfamily {
+    'RedHat': {
+    exec { 'upload-img':
+      command => "/usr/bin/glance -N ${os_auth_url} -T ${os_tenant_name} -I ${os_username} -K ${os_password} add name=${img_name} is_public=${public} container_format=${container_format} disk_format=${disk_format} distro=${os_name} < /opt/vm/cirros-x86_64-disk.img",
+      unless => "/usr/bin/glance -N ${os_auth_url} -T ${os_tenant_name} -I ${os_username} -K ${os_password} index && (/usr/bin/glance -N ${os_auth_url} -T ${os_tenant_name} -I ${os_username} -K ${os_password} index | grep ${img_name})",
+
+      }
+    }
+    'Debian': {
+    exec { 'upload-img':
+      command => "/usr/bin/glance -N ${os_auth_url} -T ${os_tenant_name} -I ${os_username} -K ${os_password} add name=${img_name} is_public=${public} container_format=${container_format} disk_format=${disk_format} distro=${os_name} < /usr/share/cirros-testvm/cirros-x86_64-disk.img",
+      unless => "/usr/bin/glance -N ${os_auth_url} -T ${os_tenant_name} -I ${os_username} -K ${os_password} index && (/usr/bin/glance -N ${os_auth_url} -T ${os_tenant_name} -I ${os_username} -K ${os_password} index | grep ${img_name})",
+      key => "E8CC67053ED3B199",
+      key_content => '-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1.4.11 (GNU/Linux)
+
+mQENBE/oXVkBCACcjAcV7lRGskECEHovgZ6a2robpBroQBW+tJds7B+qn/DslOAN
+1hm0UuGQsi8pNzHDE29FMO3yOhmkenDd1V/T6tHNXqhHvf55nL6anlzwMmq3syIS
+uqVjeMMXbZ4d+Rh0K/rI4TyRbUiI2DDLP+6wYeh1pTPwrleHm5FXBMDbU/OZ5vKZ
+67j99GaARYxHp8W/be8KRSoV9wU1WXr4+GA6K7ENe2A8PT+jH79Sr4kF4uKC3VxD
+BF5Z0yaLqr+1V2pHU3AfmybOCmoPYviOqpwj3FQ2PhtObLs+hq7zCviDTX2IxHBb
+Q3mGsD8wS9uyZcHN77maAzZlL5G794DEr1NLABEBAAG0NU9wZW5TdGFja0BDaXNj
+byBBUFQgcmVwbyA8b3BlbnN0YWNrLWJ1aWxkZEBjaXNjby5jb20+iQE4BBMBAgAi
+BQJP6F1ZAhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRDozGcFPtOxmXcK
+B/9WvQrBwxmIMV2M+VMBhQqtipvJeDX2Uv34Ytpsg2jldl0TS8XheGlUNZ5djxDy
+u3X0hKwRLeOppV09GVO3wGizNCV1EJjqQbCMkq6VSJjD1B/6Tg+3M/XmNaKHK3Op
+zSi+35OQ6xXc38DUOrigaCZUU40nGQeYUMRYzI+d3pPlNd0+nLndrE4rNNFB91dM
+BTeoyQMWd6tpTwz5MAi+I11tCIQAPCSG1qR52R3bog/0PlJzilxjkdShl1Cj0RmX
+7bHIMD66uC1FKCpbRaiPR8XmTPLv29ZTk1ABBzoynZyFDfliRwQi6TS20TuEj+ZH
+xq/T6MM6+rpdBVz62ek6/KBcuQENBE/oXVkBCACgzyyGvvHLx7g/Rpys1WdevYMH
+THBS24RMaDHqg7H7xe0fFzmiblWjV8V4Yy+heLLV5nTYBQLS43MFvFbnFvB3ygDI
+IdVjLVDXcPfcp+Np2PE8cJuDEE4seGU26UoJ2pPK/IHbnmGWYwXJBbik9YepD61c
+NJ5XMzMYI5z9/YNupeJoy8/8uxdxI/B66PL9QN8wKBk5js2OX8TtEjmEZSrZrIuM
+rVVXRU/1m732lhIyVVws4StRkpG+D15Dp98yDGjbCRREzZPeKHpvO/Uhn23hVyHe
+PIc+bu1mXMQ+N/3UjXtfUg27hmmgBDAjxUeSb1moFpeqLys2AAY+yXiHDv57ABEB
+AAGJAR8EGAECAAkFAk/oXVkCGwwACgkQ6MxnBT7TsZng+AgAnFogD90f3ByTVlNp
+Sb+HHd/cPqZ83RB9XUxRRnkIQmOozUjw8nq8I8eTT4t0Sa8G9q1fl14tXIJ9szzz
+BUIYyda/RYZszL9rHhucSfFIkpnp7ddfE9NDlnZUvavnnyRsWpIZa6hJq8hQEp92
+IQBF6R7wOws0A0oUmME25Rzam9qVbywOh9ZQvzYPpFaEmmjpCRDxJLB1DYu8lnC4
+h1jP1GXFUIQDbcznrR2MQDy5fNt678HcIqMwVp2CJz/2jrZlbSKfMckdpbiWNns/
+xKyLYs5m34d4a0it6wsMem3YCefSYBjyLGSd/kCI/CgOdGN1ZY1HSdLmmjiDkQPQ
+UcXHbA==
+=v6jg
+-----END PGP PUBLIC KEY BLOCK-----',
+
+      }
+    }
+  }
+  file { '/var/lib/gerrit/.ssh/id_rsa' :
+    owner   => 'gerrit',
+    group   => 'gerrit',
+    mode    => '0600',
+    content => $ssh_replication_rsa_key_contents,
+    replace => true,
+    require => File['/var/lib/gerrit/.ssh']
+  }
+}

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PuppetSecLint
+  VERSION = "0.1.1"
+end

data/lib/rule_engine.rb

@@ -0,0 +1,33 @@
+require 'puppet-lint'
+require_relative 'rules/rule'
+require_relative 'rules/hard_coded_credentials_rule'
+require_relative 'rules/no_http_rule'
+
+
+class RuleEngine
+  @rules=[HardCodedCredentialsRule,NoHTTPRule]
+
+  class << self
+    attr_accessor :rules
+  end
+
+  def self.getTokens(code)
+    lexer = PuppetLint::Lexer.new
+    tokens = lexer.tokenise(code)
+    return tokens
+  end
+
+  def self.analyzeDocument(code)
+    result=[]
+    tokens = self.getTokens(code)
+
+    @rules.each do |rule|
+      if rule.configurations[0].value
+        (result << rule.AnalyzeTokens(tokens)).flatten!
+      end
+    end
+
+    return result
+  end
+
+end

data/lib/rules/hard_coded_credentials_rule.rb

@@ -0,0 +1,48 @@
+require_relative '../configurations/list_configuration'
+
+class HardCodedCredentialsRule < Rule
+  @default_trigger_words = %w[pwd password pass uuid key crypt secret certificate id cert token ssh_key md5 rsa ssl]
+  @trigger_words_conf = ListConfiguration.new("List of trigger words", @default_trigger_words, "List of words that identify a variable with credentials")
+  @test_conf = BooleanConfiguration.new("Test configuration", true, "This is just a test configuration")
+
+  @name = "Hard Coded Credentials"
+  @configurations+=[@trigger_words_conf,@test_conf]
+
+  def self.AnalyzeTokens(tokens)
+    result = []
+
+    tokens.each do |indi_token|
+      nxt_token     = indi_token.next_code_token # next token which is not a white space
+      if (!nxt_token.nil?) && (!indi_token.nil?)
+        token_type   = indi_token.type.to_s ### this gives type for current token
+
+        token_line   = indi_token.line ### this gives type for current token
+        nxt_tok_line = nxt_token.line
+
+        nxt_nxt_token =  nxt_token.next_code_token # get the next next token to get key value pair
+
+        if  (!nxt_nxt_token.nil?)
+          nxt_nxt_line = nxt_nxt_token.line
+          if (token_type.eql? 'NAME') || (token_type.eql? 'VARIABLE')
+            # puts "Token type: #{token_type}"
+            if (token_line==nxt_nxt_line)
+              token_valu   = indi_token.value.downcase
+              nxt_nxt_val  = nxt_nxt_token.value.downcase
+              nxt_nxt_type = nxt_nxt_token.type.to_s  ## to handle false positives,
+
+              if (self.TriggerWordInString(token_valu)) && ((nxt_nxt_val.length > 0)) && ((!nxt_nxt_type.eql? 'VARIABLE') && (!token_valu.include? "("))
+                result.append(Sin.new(SinType::HardCodedCred, indi_token.line, indi_token.column, nxt_nxt_token.line, nxt_nxt_token.column+nxt_nxt_token.value.length))
+              end
+            end
+          end
+        end
+      end
+    end
+
+    return result
+  end
+
+  def self.TriggerWordInString(string)
+    return @trigger_words_conf.value.any? { |word| string.include?(word) }
+  end
+end

data/lib/rules/no_http_rule.rb

@@ -0,0 +1,23 @@
+require_relative '../configurations/list_configuration'
+require_relative '../sin'
+require_relative '../sin_type'
+
+class NoHTTPRule < Rule
+  @name="No HTTP Connections"
+
+  def self.AnalyzeTokens(tokens)
+    result = []
+
+    tokens.each do |indi_token|
+      token_valu = indi_token.value ### this gives each token
+      token_valu = token_valu.downcase
+      token_type = indi_token.type.to_s
+      if (token_valu.include? "http://" ) && (!token_type.eql? "COMMENT")
+        result.append(Sin.new(SinType::HttpWithoutTLS, indi_token.line, indi_token.column, indi_token.line, indi_token.column+indi_token.value.length))
+      end
+    end
+
+    return result
+  end
+
+end

data/lib/rules/rule.rb

@@ -0,0 +1,17 @@
+require_relative '../configurations/boolean_configuration'
+
+class Rule
+
+  def self.inherited(subclass)
+    subclass.configurations = [BooleanConfiguration.new("Enable Configuration", true, "Enable or disable the evaluation of the rules")]
+  end
+
+  class << self
+    attr_accessor :name, :configurations
+  end
+
+  def self.AnalyzeTokens(tokens)
+    puts "Implement this"
+    return
+  end
+end

data/lib/sin.rb

@@ -0,0 +1,15 @@
+class Sin
+  attr_accessor :type,:begin_line,:begin_char,:end_line,:end_char
+
+  def initialize(type, begin_line, begin_char, end_line, end_char)
+    @type = type
+    @begin_line = begin_line
+    @begin_char = begin_char
+    @end_line = end_line
+    @end_char = end_char
+  end
+
+  def ToString
+    return "<Sin:#{@type[:name]}, Line:#{@begin_line}, Char:#{@begin_char}, Message:#{@type[:message]}, Recommendation:#{@type[:recommendation]}>"
+  end
+end

data/lib/sin_type.rb

@@ -0,0 +1,12 @@
+module SinType
+  HardCodedCred = {
+    name: "Hard Coded Credentials",
+    message: "Do not hard code secrets. This may help an attacker to attack the system.",
+    recommendation: "You can use hiera to avoid this issue."
+  }
+  HttpWithoutTLS = {
+    name: "HTTP without TLS",
+    message: "Do not use HTTP without TLS. This may cause a man in the middle attack.",
+    recommendation: "Use TLS with HTTP"
+  }
+end

data/lib/visitors/configuration_visitor.rb

@@ -0,0 +1,27 @@
+require_relative '../rule_engine'
+
+class ConfigurationVisitor
+  def self.Visit
+    configurationsHash = {}
+
+    rules = RuleEngine.rules
+    rules.each do |rule|
+      configurationsHash[rule] = []
+      rule.configurations.each do |configuration|
+        configurationsHash[rule].append(configuration)
+      end
+    end
+
+    return configurationsHash
+  end
+
+  def self.GenerateIDs
+    configurationsHash = self.Visit
+
+    configurationsHash.each do |rule,configurations|
+      configurations.each do |configuration|
+        configuration.id = "#{rule}-#{configuration.name.downcase.gsub! ' ', '_'}"
+      end
+    end
+  end
+end

data/puppet-sec-lint.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/puppet-sec-lint/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "puppet-sec-lint"
+  spec.version       = PuppetSecLint::VERSION
+  spec.authors       = ["Tiago Ribeiro"]
+  spec.email         = ["tiago7b27@gmail.com"]
+
+  spec.summary       = "This is a security linter for the puppet language"
+  spec.description   = "This is a more complete security linter for the puppet language"
+  spec.homepage      = "https://github.com/TiagoR98/puppet-sec-lint"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/TiagoR98/puppet-sec-lint"
+  spec.metadata["changelog_uri"] = "https://github.com/TiagoR98/puppet-sec-lint"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: puppet-sec-lint
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tiago Ribeiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-11 00:00:00.000000000 Z
+dependencies: []
+description: This is a more complete security linter for the puppet language
+email:
+- tiago7b27@gmail.com
+executables:
+- puppet-sec-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".idea/.gitignore"
+- ".idea/modules.xml"
+- ".idea/puppet-sec-lint.iml"
+- ".idea/vcs.xml"
+- Architecture/Architecture.eap
+- Architecture/Class Model.png
+- Architecture/Component Model.png
+- Architecture/See settings.png
+- Architecture/VSCode Analyze.png
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/puppet-sec-lint
+- lib/configurations/boolean_configuration.rb
+- lib/configurations/configuration.rb
+- lib/configurations/list_configuration.rb
+- lib/facades/configuration_file_facade.rb
+- lib/facades/configuration_page_facade.rb
+- lib/language_server.rb
+- lib/lol.pp
+- lib/puppet-sec-lint/version.rb
+- lib/rule_engine.rb
+- lib/rules/hard_coded_credentials_rule.rb
+- lib/rules/no_http_rule.rb
+- lib/rules/rule.rb
+- lib/sin.rb
+- lib/sin_type.rb
+- lib/visitors/configuration_visitor.rb
+- puppet-sec-lint-0.1.0.gem
+- puppet-sec-lint.gemspec
+homepage: https://github.com/TiagoR98/puppet-sec-lint
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/TiagoR98/puppet-sec-lint
+  source_code_uri: https://github.com/TiagoR98/puppet-sec-lint
+  changelog_uri: https://github.com/TiagoR98/puppet-sec-lint
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: This is a security linter for the puppet language
+test_files: []