{"id":15493296,"url":"https://github.com/mostafa/validate-sigma-rules","last_synced_at":"2025-03-04T07:30:54.732Z","repository":{"id":222311009,"uuid":"756868352","full_name":"mostafa/validate-sigma-rules","owner":"mostafa","description":"Validates Sigma rules using the JSON schema","archived":true,"fork":false,"pushed_at":"2024-03-15T13:57:18.000Z","size":39,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-19T11:11:11.169Z","etag":null,"topics":["actions","sigma","validator"],"latest_commit_sha":null,"homepage":"https://github.com/SigmaHQ/sigma","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mostafa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-13T13:20:17.000Z","updated_at":"2024-03-19T21:31:12.000Z","dependencies_parsed_at":"2024-03-13T16:40:27.187Z","dependency_job_id":"a5136c9f-f389-4074-aaa9-c6798ab941b1","html_url":"https://github.com/mostafa/validate-sigma-rules","commit_stats":null,"previous_names":["mostafa/validate-sigma-rules"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mostafa%2Fvalidate-sigma-rules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mostafa%2Fvalidate-sigma-rules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mostafa%2Fvalidate-sigma-rules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mostafa%2Fvalidate-sigma-rules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mostafa","download_url":"https://codeload.github.com/mostafa/validate-sigma-rules/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241804524,"owners_count":20023041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","sigma","validator"],"created_at":"2024-10-02T08:05:21.109Z","updated_at":"2025-03-04T07:30:54.322Z","avatar_url":"https://github.com/mostafa.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# validate-sigma-rules\n\nThis action is used to validate Sigma rules using the JSON schema. It is used to ensure that the rules are correctly formatted and that they will work with the Sigma converter.\n\n## Usage\n\nFor an example repository structure, see the [example repository](https://github.com/mostafa/validate-sigma-rules-example).\n\n```yaml\nsteps:\n    - uses: mostafa/validate-sigma-rules@v0\n      with:\n        paths: './'\n        schemaURL: 'https://raw.githubusercontent.com/SigmaHQ/sigma-specification/main/sigma-schema.json'\n```\n\nIf you want to use an existing schema, you can use the `schemaFile` input:\n\n```yaml\nsteps:\n    - uses: mostafa/validate-sigma-rules@v0\n      with:\n        paths: './'\n        schemaFile: './sigma-schema.json'\n```\n\nThe `paths` can be used to provide multiple paths to the rules. For example, if you have a `rules` directory and a `custom-rules` directory, you can use the following:\n\n```yaml\nsteps:\n    - uses: mostafa/validate-sigma-rules@v0\n      with:\n        paths: |-\n          ./rules\n          ./custom-rules\n```\n\n## Inputs\n\n### `paths` (optional)\n\nThe path(s) to the Sigma rules in your repository. This is a optional input and should be a relative path to the root of the repository. The default value is `./`.\n\n### `schemaURL` (optional)\n\nThe URL to the latest version of the JSON schema for Sigma (or any other version or commit). This is an optional input and should be a URL to the JSON schema. The default value can be the latest version of the Sigma schema from the [sigma-specification repository](https://github.com/SigmaHQ/sigma-specification):\n\n```yaml\n...\nschemaURL: 'https://raw.githubusercontent.com/SigmaHQ/sigma-specification/main/sigma-schema.json'\n...\n```\n\n### `schemaFile` (optional)\n\nThe path to the JSON schema for Sigma. This is an optional input and should be a relative path to the root of the repository.\n\n\u003e [!IMPORTANT]\n\u003e Either `schemaURL` or `schemaFile` should be provided. If both are provided, an error will be thrown with a non-zero exit code. If `schemaFile` is provided and the file doesn't exist, an error will be thrown with a non-zero exit code. If none are provided, the action will use the default schema from the [sigma-specification repository](https://github.com/SigmaHQ/sigma-specification), as mentioned above.\n\n## Outputs\n\nIt returns a zero exit code if the validation is successful and a non-zero exit code and errors if the validation fails.\n\n## License\n\nThe scripts and documentation in this project are released under the [Apache-2.0 License](LICENSE).\n\n## Contributions\n\nContributions are welcome! Just open an issue or a PR.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmostafa%2Fvalidate-sigma-rules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmostafa%2Fvalidate-sigma-rules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmostafa%2Fvalidate-sigma-rules/lists"}