InSpec Extension for Visual Studio Code

This extension for Visual Studio Code provides grammar and code snippets for InSpec when using Visual Studio Code.

Features

Syntax/keyword highlighting:

• InSpec - control blocks
• InSpec - describe blocks
• InSpec - resource

Installation

• You will need to install Visual Studio Code 1.5 or higher.

• From the command palette Ctrl-Shift-P (Windows, Linux) or Cmd-Shift-P (OSX) select Install Extension, choose Inspec and reload Visual Studio Code.

• Once the Extention is installed to enable it, choose the InSpec language from the bottom right corner (the default is Plain Text) It should then look like this

  

• .... or use the keyboard shortcut (Ctrl-K) M & type Inspec if you happen to be scared of mice :)

Usage

InSpec in it's simplest form is describe block in which you describe a resource's expected configuration. e.g.

describe file('/etc/myapp.conf') do
  it { should exist }
  its('mode') { should cmp '0644' }
end

TIP: Try typing the resource you want to use i.e. file and let the snippet create the describe block for you

What is InSpec?

InSpec is an open-source testing framework for infrastructure with a human- and machine-readable language for specifying compliance, security and policy requirements.

Where can I find more?

The inspec.io website is full of documentation and links to download the code There is also an interactive demo in which will allow you try it out with a web browser.

InSpec Snippet Support matrix

InSpec Resource	Extension Snippet
aws_billing_report	✅ aws_billing_report
aws_billing_reports	✅ aws_billing_reports
aws_cloudtrail_trail	✅ aws_cloudtrail_trail
aws_cloudtrail_trails	✅ aws_cloudtrail_trails
aws_cloudwatch_alarm	✅ aws_cloudwatch_alarm
aws_cloudwatch_log_metric_filter	✅ aws_cloudwatch_log_metric_filter
aws_config_delivery_channel	✅ aws_config_delivery_channel
aws_config_recorder	✅ aws_config_recorder
aws_ec2_instance	✅ aws_ec2_instance
aws_ebs_volume	✅ aws_ebs_volume
aws_ebs_volumes	✅ aws_ebs_volumes
aws_flow_log	✅ aws_flow_log
aws_ec2_instances	✅ aws_ec2_instances
aws_ecs_cluster	✅ aws_ecs_cluster
aws_eks_cluster	✅ aws_eks_cluster
aws_elb	✅ aws_elb
aws_elbs	✅ aws_elbs
aws_iam_access_key	✅ aws_iam_access_key
aws_iam_access_keys	✅ aws_iam_access_keys
aws_iam_group	✅ aws_iam_group
aws_iam_groups	✅ aws_iam_groups
aws_iam_password_policy	✅ aws_iam_password_policy
aws_iam_policies	✅ aws_iam_policies
aws_iam_policy	✅ aws_iam_policy
aws_iam_role	✅ aws_iam_role
aws_iam_root_user	✅ aws_iam_root_user
aws_iam_user	✅ aws_iam_user
aws_iam_users	✅ aws_iam_users
aws_kms_key	✅ aws_kms_key
aws_kms_keys	✅ aws_kms_keys
aws_rds_instance	✅ aws_rds_instance
aws_route_table	✅ aws_route_table
aws_route_tables	✅ aws_route_tables
aws_s3_bucket	✅ aws_s3_bucket
aws_s3_bucket_object	✅ aws_s3_bucket_object
aws_s3_buckets	✅ aws_s3_buckets
aws_security_group	✅ aws_security_group
aws_security_groups	✅ aws_security_groups
aws_sns_subscription	✅ aws_sns_subscription
aws_sns_topic	✅ aws_sns_topic
aws_sns_topics	✅ aws_sns_topics
aws_sqs_queue	✅ aws_sqs_queue
aws_subnet	✅ aws_subnet
aws_subnets	✅ aws_subnets
aws_vpc	✅ aws_vpc
aws_vpcs	✅ aws_vpcs
azure_generic_resource	✅ azure_generic_resource
azure_resource_group	✅ azure_resource_group
azure_virtual_machine	✅ azure_virtual_machine
azure_virtual_machine_data_disk	✅ azure_virtual_machine_data_disk
aide_conf	✅ aide_conf
apache	✅ apache
apache_conf	✅ apache_conf
apt	✅ apt
ppa	✅ ppa
audit_policy	✅ audit_policy
auditd	✅ auditd
auditd_conf	✅ auditd_conf
command	✅ command
bash	✅ bash
file	✅ file
bond	✅ bond
bridge	✅ bridge
chocolatey_package	✅ chocolatey_package
cran	✅ cran
cpan	✅ cpan
crontab	✅ crontab
dh_params	✅ dh_params
directory	✅ directory
docker	✅ docker
docker_container	✅ docker_container
docker_image	✅ docker_image
docker_plugin	✅ docker_plugin
docker_service	✅ docker_service
package	✅ package
elasticsearch	✅ elasticsearch
etc_fstab	✅ etc_fstab
etc_group	✅ etc_group
etc_hosts_allow	✅ etc_hosts_allow
etc_hosts_deny	✅ etc_hosts_deny
etc_hosts	✅ etc_hosts
filesystem	✅ filesystem
firewalld	✅ firewalld
gem	✅ gem
groups	✅ groups
group	✅ group
grub_conf	✅ grub_conf
host	✅ host
http	✅ http
iis_app	✅ iis_app
iis_app_pool	✅ iis_app_pool
iis_site	✅ iis_site
iis_website	✅ iis_website
inetd_conf	✅ inetd_conf
interface	✅ interface
iptables	✅ iptables
json	✅ json
kernel_module	✅ kernel_module
kernel_parameter	✅ kernel_parameter
linux_kernel_parameter	✅ linux_kernel_parameter
key_rsa	✅ key_rsa
ksh	✅ ksh
limits_conf	✅ limits_conf
login_defs	✅ login_defs
mount	✅ mount
mssql_session	✅ mssql_session
mysql	✅ mysql
mysql_conf	✅ mysql_conf
mysql_session	✅ mysql_session
nginx	✅ nginx
nginx_conf	✅ nginx_conf
npm	✅ npm
ntp_conf	✅ ntp_conf
oneget	✅ oneget
oracledb_session	✅ oracledb_session
platform	✅ platform
os	✅ os
os_env	✅ os_env
packages	✅ packages
parse_config	✅ parse_config
parse_config_file	✅ parse_config_file
passwd	✅ passwd
pip	✅ pip
port	✅ port
postgres	✅ postgres
postgres_conf	✅ postgres_conf
postgres_hba_conf	✅ postgres_hba_conf
postgres_ident_conf	✅ postgres_ident_conf
postgres_session	✅ postgres_session
powershell	✅ powershell
script	✅ script
processes	✅ processes
rabbitmq_config	✅ rabbitmq_config
registry_key	✅ registry_key
windows_registry_key	✅ windows_registry_key
security_identifier	✅ security_identifier
security_policy	✅ security_policy
service	✅ service
systemd_service	✅ systemd_service
upstart_service	✅ upstart_service
sysv_service	✅ sysv_service
bsd_service	✅ bsd_service
launchd_service	✅ launchd_service
runit_service	✅ runit_service
shadow	✅ shadow
ssh_config	✅ ssh_config
sshd_config	✅ sshd_config
ssl	✅ ssl
sys_info	✅ sys_info
toml	✅ toml
users	✅ users
user	✅ user
vbscript	✅ vbscript
virtualization	✅ virtualization
windows_feature	✅ windows_feature
windows_hotfix	✅ windows_hotfix
windows_task	✅ windows_task
wmi	✅ wmi
x509_certificate	✅ x509_certificate
xinetd_conf	✅ xinetd_conf
yum	✅ yum
zfs_dataset	✅ zfs_dataset
zfs_pool	✅ zfs_pool
yaml	✅ yaml
csv	✅ csv
ini	✅ ini
xml	✅ xml

Publishing

This describes the setup procedure for the tools and tokens required to publish the extension: https://code.visualstudio.com/docs/tools/vscecli

# Install the dependencies for the project
$ npm install
# Publish a version of the extension
$ npm publish (major|minor|patch)

Contributions

Contributions are welcomed, please create an issue and a pull requests via the project homepage.

Version History

Review the CHANGELOG.md