ggbecker/content-navigator

Content Navigator is a VSCode/Codium extension which helps security content authors to create content for https://github.com/ComplianceAsCode/content

content-navigator's Issues

new template `bls_bootloader_option`

bls_bootloader_option::

• Checks kernel command line arguments in BLS-compatible (Boot Loader Specification) boot loader configuration.
• Parameters:
  ** arg_name - argument name, eg. audit
  ** arg_value - argument value, eg. '1'
• Languages: OVAL

Include documentation from dconf_ini_file template

https://complianceascode.readthedocs.io/en/latest/manual/developer/06_contributing_with_content.html#dconf-ini-file

Replace test_suite.py with automatus.py

Use preview property defined by VSCode when opening text editor

Reuse the configured property provided by VSCode to decide whether to open files in preview mode or not.

[RFE] Show templated content from rule id

Detect that rule.yml contains template: tag (use name: to identify templated file) and show respective template file according to requested content.

Template (bash, ansible, oval) - show template file associated?

[RFE] Detect which profiles a rule is part of

From a given rule id, show every profile this rule is selected.

Check possible integration with: https://github.com/redhat-developer/yaml-language-server

integrate with redhat telemetry

https://github.com/redhat-developer/vscode-redhat-telemetry#how-to-disable-telemetry-reporting

Open variable file

Use same shortcut command as opening rule to open a variable file when the text selected belongs to a variable file. Variable files are usually contain the extension .var

Add examples of usage in gif format to the documentation

Images from this blog post can be used: https://complianceascode.github.io/template/2019/12/19/content-navigator-a-vscode-extension.html

Source code is found here: https://github.com/ComplianceAsCode/ComplianceAsCode.github.io/tree/master/assets/images

Strip new lines when using content from clipboard

Sometimes the content from the clipboard can contain some disposable characters which would led us to a valid content. Remove special characters from the string if the first attempt to open a content is unsuccessful

Trim semi colon from clipboard data when opening content

For example, double clicking the text no_empty_passwords: in a terminal would include the trailing semi colon which would result in content-navigator not finding the content.

[RFE] Add support for newly Ignition remediation type

From: ComplianceAsCode/content#5137

Add variables to the list of completion items provided in profiles and controls files.

Publish extension on https://open-vsx.org/user-settings/tokens

https://github.com/eclipse/openvsx/wiki/Publishing-Extensions

[RFE] Add debug configurations support

Provide easy way to setup SSG test suite on VSCode to ease running test scenarios.

Add new template shell_lineinfile to snippets file

shell_lineinfile template from https://github.com/ComplianceAsCode/content/blob/master/docs/manual/developer_guide.adoc#732-list-of-available-templates

Clipboard should take precedence when opening a content

With the introduction of navigation between content from a given rule, it may happen that when trying to open a content for a different rule from clipboard, the extension will try first to navigate between using rule id from current content. So one would need to open a different file, rather than a content file, before activating the option to jump into content.

[RFE] Add support for copying profile ID in prefixed format

Prefix: xccdf_org.ssgproject.content_profile_

Leverage the intermediate compiled files from CaC/content to show built content

Sometimes, automated content contain Jinja macros that are only expanded when building content, then there are several compiled files that can be used to show the full content. Implement a feature to display this kind of built content.

update yamlfile_value snippet template documentation

ComplianceAsCode/content#6332

Add platform tag to rule snippet

Add platform tag to rule snippets: https://github.com/ggbecker/content-navigator/blob/master/snippets.json

Update sysctl template snippets

https://github.com/ComplianceAsCode/content/pull/9147/files#diff-c8641b0ad93f2eb96677145b8a577238397c4e74caf381637076674e75694c01

Add build_product run configuration to the snippets section

Jump to content from tests/ directory

Open built content - display found directories so the user can select which product they want to open

When building content for multiple products, display a selection text box so the user can pick from the found built products.

Create github pages.

Add Copy Rule ID to right click file tab menu

Improve rule id detection

Identify this as a rule

if the string ends with rule.yml and others variations, try to guess the the rule id.

linux_os/guide/system/permissions/files/permissions_within_important_dirs/dir_group_ownership_library_dirs/rule.yml

[RFE] Copy rule id in full prefixed format

The function is similar to Copy Rule ID but would append the full prefix xccdf_org.ssgproject.content_rule_. It helps when scanning a particular rule using OpenSCAP as oscap still does not support short rule id and using the full prefixed rule id is mandatory.

Add launch.json configuration file to the official ComplianceAsCode/content project

The prebuilt file can help people easily use run configuration through VSCode/VSCodium

Show options only when content project is opened in current workspace

Ctrl+Alt+A combination is somehow captured by Xorg+GNOME

In some cases it can block opening of Ansible content (Ctrl+Alt+A)

https://unix.stackexchange.com/questions/504858/cinnamon-getting-rid-of-ctrl-alt-a-shortcut

Add open variable function to consider prefixed ids

For example:
xccdf_org.ssgproject.content_value_var_password_pam_minlen
content_value_var_password_pam_minlen

Add tests using code from ComplianceAsCode/content

Implement tests based on ComplianceAsCode/content. Fetch latest version of content and run tests against it. This way the latest version of content project will be tested.

Test mainly functions to open content from a given rule.

Add option to open kubernetes remediation

Open content does not match prefixed rules

Use the same tricks used when data comes from the clipboard

Update documentation in the README page including links

Sanitize input of clipboard

Accept input only if contains alphanumeric and _, -

{{{ ansible_sshd_set(parameter="MACs", value="{{ sshd_approved_macs }}") }}}

command failed with error code 2: error parsing glob '**/ {{{ ansible_sshd_set(parameter="MACs", value="{{ sshd_approved_macs }}") }}}/ansible/shared.yml': nested alternate groups are not allowed

Add walkthrough content

https://code.visualstudio.com/api/references/contribution-points#contributes.walkthroughs

Store last rule id retrieved when running test suite

That might help when the active editor does not contain an associated rule (for example a log file), but the user wants to run the test suite again using previously tested rule id.

Extend this function: https://github.com/ggbecker/content-navigator/blob/master/src/content-navigator.ts#L5 (getRuleId)

new template yamlfile_value

yamlfile_value::

• Check if value(s) of certain type is (are) present in a YAML (or JSON) file at a given path.
• Parameters:
  ** filepath - full path to the file to check
  ** yamlpath - OVAL's link:https://github.com/OpenSCAP/yaml-filter/wiki/YAML-Path-Definition[YAML Path] expression.
  ** value - the value to check.
  ** type (SimpleDatatypeEnumeration) - datatype for state's value_of, optional.
  ** entity_check (CheckEnumeration) - entity_check value for state's value_of, optional.
  ** pattern_check - if set to "true", the value is handled as a pattern match for state's value_of, optional.
  ** negate - if set to "true" the meaning of the value check criterion would be inverted, optional.
  ** ocp_data - if set to "true" then the filepath would be treated as a part of the dump of OCP configuration with the ocp_data_root prefix; optional.
• Languages: OVAL

Open content does not work when there is no active editor

Bring this piece of code outside the if(active) block so it probably will work to open content when there is no active editor but there are valid content in the clipboard:

content-navigator/src/content-navigator.ts

Lines 89 to 106 in 29a924d

	rule_id = await vscode.env.clipboard.readText();
	// sometimes huge amount of nonsense text can be in the clipboard so lets reduce the scope here with length < 120
	if(rule_id.length > 0 && rule_id.length < 120)
	{
	let index_full_prefix = rule_id.indexOf('xccdf_org.ssgproject.content_rule_');
	let index_short_prefix = rule_id.indexOf('content_rule_');
	if(index_full_prefix == 0)
	{
	rule_id = rule_id.slice('xccdf_org.ssgproject.content_rule_'.length)
	}
	else if(index_short_prefix == 0)
	{
	rule_id = rule_id.slice('content_rule_'.length)
	}
	if(await openFile(rule_id, location)){
	return;
	}
	}

Open template folder using the template name

Open the template.yml file of a template.

Use dynamic snippets by adoption completion feature

https://stackoverflow.com/questions/39413783/dynamic-snippet-evaluation-in-vscode