Ghostwriter

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 5139 is passing Here is how to embed it:

These are the Passing level criteria. You can also view the Silver or Gold level criteria.

        

 Basics 13/13

  • Identification

    The SpecterOps project management and reporting engine

    What programming language(s) are used to implement the project?
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    The project is briefly described on the welcome page of the project's wiki and in the repository's README: https://www.ghostwriter.wiki/ https://github.com/GhostManager/Ghostwriter/blob/master/README.md



    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The wiki discusses how to provide feedback and report issues: https://www.ghostwriter.wiki/known-issues-and-faq/getting-help-with-a-problem



    La información sobre cómo contribuir DEBE explicar el proceso de contribución (por ejemplo, ¿se utilizan "pull requests" en el proyecto?) (URL required) [contribution]

    The wiki walks through how to contribute: https://www.ghostwriter.wiki/development/contributing-to-the-project

    The wiki also documents the project's code style required for contributions: https://www.ghostwriter.wiki/coding-style-guide/style-guide



    The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]
  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_license]

    All code is released publicly on GitHub, the project road map is tracked publicly on Trello, and everything is under the BSD 3 license.

    https://github.com/GhostManager/Ghostwriter/blob/master/LICENSE https://trello.com/b/sF4om6Fy/ghostwriter The BSD-3-Clause license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The BSD-3-Clause license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]
  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    The project team maintains a wiki that covers installation, usage, maintenance, and other required information: https://ghostwriter.wiki/



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]

    The project team maintains a wiki that covers installation, usage, maintenance, and other required information: https://ghostwriter.wiki/


  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    Project discussions (and the project team) are available via GitHub Issues, Trello, and the #ghostwriter channel in the SpecterOps BloodHound Slack Team (https://bloodhoundgang.herokuapp.com/).



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    The project team maintains a wiki (in English) that covers installation, usage, maintenance, and other required information: https://ghostwriter.wiki/. All discussion of enhancements, issues, etc. is in English.



    The project MUST be maintained. [maintained]

    The project team actively maintains Ghostwriter and publishes regular releases and blog posts.



(Advanced) What other users have additional rights to edit this badge entry? Currently: []



  • Repositorio público para el control de versiones de código fuente


    El proyecto DEBE tener un repositorio público para el control de versiones de código fuente que sea legible públicamente y tenga URL. [repo_public]

    Repository on GitHub, which provides public git repositories with URLs.



    El repositorio fuente del proyecto DEBE rastrear qué cambios se realizaron, quién realizó los cambios y cuándo se realizaron los cambios. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    The project publishes release candidates for review. Here is a recent example: https://github.com/GhostManager/Ghostwriter/releases/tag/2.2-rc1



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


  • Numeración única de versión


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    The project follows GitHub's guidelines for Semantic Versioning when naming versions. Each release has a unique version number and identifier (e.g., v2.2.0, v2.2.1-rc1).

    https://github.com/GhostManager/Ghostwriter/releases



    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

    The project tags releases using git tags: https://github.com/GhostManager/Ghostwriter/releases


  • Notas de lanzamiento


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    The project publishes a CHANGELOG.RST, release notes in the release descriptions, and an easier to read, searchable version on the wiki:

    https://github.com/GhostManager/Ghostwriter/releases/tag/v2.2.1 https://www.ghostwriter.wiki/change-logs/28-may-2021-v2.2.1 https://github.com/GhostManager/Ghostwriter/blob/master/DOCS/CHANGELOG.RST



    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]

    There have been no major vulnerabilities like this to report, but the release notes have acknowledged when changes were the result of an identified security issue in a dependency. For example:

    Updated TinyMCE WYSIWYG editor and related JavaScript to v5.7.0 * Resolved potential Cross-Site Scripting vulnerability discovered in previous version


  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    The project uses GitHub Issues as documented here: https://www.ghostwriter.wiki/known-issues-and-faq/getting-help-with-a-problem



    The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    The project uses a public Trello board to track issues and features: https://trello.com/b/sF4om6Fy/ghostwriter



    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    The project team always acknowledges GitHub Issues, even if the issue cannot be fixed immediately. The team cannot always respond right away, but does their best to keep up with issues and respond with complete answers.

    https://github.com/GhostManager/Ghostwriter/issues



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    The project team always acknowledges GitHub Issues, even if the enhancement cannot be implemented immediately. The team cannot always respond right away, but does their best to keep up with issues and respond with complete answers.

    https://github.com/GhostManager/Ghostwriter/issues



    El proyecto DEBE tener un archivo públicamente disponible para informes y respuestas para búsquedas posteriores. (URL required) [report_archive]

    All reports are in GitHub Issues which are searchable for later review.

    https://github.com/GhostManager/Ghostwriter/issues


  • Proceso de informe de vulnerabilidad


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    A process for reporting a bug or security vulnerability is outlined in the wiki: https://www.ghostwriter.wiki/known-issues-and-faq/getting-help-with-a-problem



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    The project team discusses these issues openly. There has been no need to discuss anything in private, but there is a method of private contact. Anyone may contact the lead developer at chris.maddalena@protonmail.com (as published on GitHub).

    https://github.com/chrismaddalena



    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]

    The team has responded within days of reports received in the project's lifetime. There have been no vulnerability reports in the past 6 months, but there was one Dependabot alert for TinyMCE that the team addressed immediately.


  • Working build system


    Si el software generado por el proyecto requiere ser construido para su uso, el proyecto DEBE proporcionar un sistema de compilación que pueda satisfactoriamente reconstruir automáticamente el software a partir del código fuente. [build]

    All pieces of the project that require any building are managed and built by docker-compose: https://www.ghostwriter.wiki/getting-started/installation



    Se SUGIERE que se utilicen herramientas comunes para construir el software. [build_common_tools]

    The project uses common tools and frameworks like Docker, Django, PostreSQL, and Redis.



    El proyecto DEBERÍA ser construible usando solo herramientas FLOSS. [build_floss_tools]

    All project components are open-source and freely available, including components used to build or run the project.


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    The project follows the Django project's recommended practices for using Django's TestCase unit tests. Test coverage is monitored using Python coverage and Codecov.

    https://www.ghostwriter.wiki/development/testing-code https://app.codecov.io/gh/ghostmanager/Ghostwriter



    Un conjunto de pruebas DEBERÍA ser invocable de forma estándar para ese lenguaje. [test_invocation]

    All tests are invoked using the standard Django (or Python coverage) commands as documented by those projects and in the Ghostwriter wiki:

    https://www.ghostwriter.wiki/development/testing-code



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    Tests are run against all code, regardless of the branch. GitHub Actions runs the full suite against all pull requests or commits to master. Further, the workflow must pass before the code can be committed.



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

    GitHub Actions performs a complete build and install of Docker images, runs through the "getting started" instructions to prep the database, and runs all unit tests.


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]


    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]

    The project has started tracking testing coverage with Codecov so it is publicly viewable and updated with each push: https://app.codecov.io/gh/ghostmanager/Ghostwriter



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    Testing steps and policy is documented here: https://www.ghostwriter.wiki/development/testing-code


  • Banderas de advertencia


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]

    No part of the project requires compilation like this, so most of this is handled by the test cases.

    The project uses a documented mix of pre-commit hooks, IDE settings, and linter settings (Python Black and Flake8) to ensure code quality. Quality is also being monitored by Code Factor to guide the team towards problem areas.

    https://www.ghostwriter.wiki/coding-style-guide/style-guide https://www.codefactor.io/repository/github/ghostmanager/ghostwriter/issues



    El proyecto DEBE abordar las advertencias. [warnings_fixed]

    As mentioned above, no part of this project requires compilation, so this does not appear to be applicable. Otherwise, it is met by way of catching these common mistakes before the code is committed. Any Python compilation issues would prevent Django from functioning and prevent a release.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    The project team is actively working towards providing user-friendly warnings and help messages when various runtime errors occur. For example, when attempting to generate a Microsoft Word document with Jinja2 a user may try to divide by zero. Rather than pass along the Jinja2 compilation error, the project filters it and produces a friendlier message explaining how to resolve the issue in their template.


  • Conocimiento de desarrollo seguro


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]

    The lead developer, Christopher Maddalena, is a security consultant with a background in Computer Science, web application security testing, and secure software development.



    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

    In addition to the lead developer, the other primary contributors also have background in information security, web application testing, secure code reviews, and more.


  • Use buenas prácticas criptográficas

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    The software produced by the project MUST use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]

    The project does not require much cryptography, but Django uses it for securing user passwords and sensitive information. Ghostwriter uses the latest recommended cryptography libraries for this.

    Django documents it here: https://docs.djangoproject.com/en/3.2/topics/auth/passwords/



    Si el software producido por el proyecto es una aplicación o una librería, y su propósito principal no es implementar criptografía, entonces DEBE SOLAMENTE invocar un software específicamente diseñado para implementar funciones criptográficas; NO DEBERÍA volver a implementar el suyo. [crypto_call]

    The project does not implement its own cryptography. Only the major supported Python cryptography libraries are used.



    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    The project uses Django's cryptography implementations which is FLOSS: https://docs.djangoproject.com/en/3.2/topics/auth/passwords/



    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]

    The project uses Django's cryptography implementations which follows these standards: https://docs.djangoproject.com/en/3.2/topics/auth/passwords/



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]

    The project uses Django's cryptography implementations which uses the recommended, standard Python libraries and their algorithms: https://docs.djangoproject.com/en/3.2/topics/auth/passwords/



    The default security mechanisms within the software produced by the project SHOULD NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]

    The project uses Django's cryptography implementations which uses the recommended, standard Python libraries and their algorithms: https://docs.djangoproject.com/en/3.2/topics/auth/passwords/



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    The project uses Django's security recommendations and features. Where this would most likely come into play, HTTPS traffic, the project uses an nginx server and Django manages the SSL as described here.

    https://docs.djangoproject.com/en/3.2/topics/security/#ssl-https



    If the software produced by the project causes the storing of passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]

    The project uses Django's password management and user authentication mechanisms described here: https://docs.djangoproject.com/en/3.2/topics/auth/passwords/



    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]

    The project uses Django's password management and user authentication mechanisms described here: https://docs.djangoproject.com/en/3.2/topics/auth/passwords/


  • Entrega garantizada contra ataques de hombre en el medio (MITM)


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    The project uses HTTPS and WebSockets Secure for communication. Here is the nginx.conf file for the webserver with the SSL configuration:

    https://github.com/GhostManager/Ghostwriter/blob/master/compose/production/nginx/nginx.conf



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

    The project does not send or receive cryptographic material.


  • Vulnerabilidades públicamente conocidas corregidas


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    There are no unpatched public vulnerabilities in the project's codebase.



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    The project team has addressed all reported vulnerabilities. In addition to that, the project team has paid a third party to perform a penetration test against the Ghostwriter production server and features and fixed all identified issues.


  • Otros problemas de seguridad


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    There is no sensitive information stored in the project's code repository. This is monitored using manual validation and tools like the OSSF's Scorecard (https://github.com/ossf/scorecard/).


  • Análisis estático de código


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]

    GitHub's CodeQL app searches for common vulnerabilities.



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]

    None have been found, but identified vulnerabilities would be addressed with the same alacrity as mentioned previously.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    The CodeQL workflow fires with each commit and pull request.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    The project team tests and fuzzes Ghostwriter using Burp Suite Pro, a web application testing tool, to test changes.



    It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]

    The project does not contain any code written in a memory-unsafe language, but the team does fuzz the web application and back-end to identify potential issues that might cause serious errors or expose the potential for misuse of a feature.



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]

    The project team uses rulesets published by PortSwigger, the creator of Burp Suite, to fuzz the Ghostwriter server for automated dynamic testing.



    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]

    None have been found, but identified vulnerabilities would be addressed with the same alacrity as mentioned previously.



This data is available under the Creative Commons Attribution version 3.0 or later license (CC-BY-3.0+). All are free to share and adapt the data, but must give appropriate credit. Please credit Christopher Maddalena and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Christopher Maddalena.
Entry created on 2021-08-11 16:44:02 UTC, last updated on 2021-08-11 20:08:12 UTC. Last achieved passing badge on 2021-08-11 20:08:12 UTC.

Back