Ortelius

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 5725 is in_progress Here is how to embed it:

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

        

 Basics 8/13 ●

  • Identification

    Ortelius is a unified microservice catalog that versions and tracks microservices, their consuming applications, ownership, blast radius and where they have been deployed with all critical deployment metadata. By centralizing and tracking detailed configuration data, Ortelius provides you a proactive view of how your microservice architecture is changing overtime. The latest version of Ortelius is maintained by the Ortelius Community managed by the Continuous Delivery Foundation (Linux Foundation). It was originally created by DeployHub and OpenMake Software. Our mission is to simplify the adoption of modern architecture through a world-class microservice management platform driven by a supportive and diverse global open source community.

    What programming language(s) are used to implement the project?

  • Basic project website content


    Enough for a badge!

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

    Enough for a badge!

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

    Enough for a badge!

    Habari juu ya jinsi ya kuchangia LAZIMA ieleze mchakato wa uchangiaji (kwa mfano, je! Maombi ya kuvuta yanatumika?) (URL required) [contribution]

    https://ortelius.io/contributor/


    Enough for a badge!

    Habari juu ya jinsi ya kuchangia INAPASWA kujumuisha mahitaji ya michango inayokubalika (k.m., rejeleo la kiwango chochote kinachohitajika cha usimbaji). (URL required) [contribution_requirements]

    https://docs.ortelius.io/guides/contributorguide/how-to/ Opening an Issue GitHub Issues are used to track all bugs, enhancement requests, and “todos.” Ortelius is spread across many repositories so the ortelius/ortelius repo is used for all issues. Issues should have a link, using markdown link format, to the true repository in which the bug, enhancement, or “todos” needs to be made.

    Please be detailed in your description of the issue. Not everything needs to go in the summary line. Feel free to use the description area to provide additional details.

    Making documentation changes Documentation is stored in ortelius/ortelius-docs. The documentation is served up by a hugo/docsy server. You can run this server locally to view your changes before committing to Github.

    The documentation is managed in two Guides - a User Guide and a Contributor Guide.

    Setup for Documenation updates Install hugo locally. If you are on Windows make sure to install the extended packages as well. Fork the ortelius/ortelius-docs to your GitHub account. Clone the new repo to your computer. Launch an editor such as Visual Studio Code. Make sure the Markdown Preview Enhanced by Yiyi Wang is installed. This will give you a split screen of the markdown and the rendered version. The markdown files can be found under the content/en/guides/contributorguide (this guide) and the content/en/guides/userguide (the end user guide). Start your hugo server. Open a command prompt and cd to your local git repo directory. From the root of the repo run hugo server. This will start the local hugo server running. The pages can be viewed in your browser using the http://localhost:1313/guides url. Next make a documentation change. This change will automatically be seen in the Visual Studio Code - Markdown Preview Enhanced window. Also, the hugo server will automatically render the changed markdown page. Note: Visual Studio is only a preview and will not render all markdown updates such as embedded html. You will need to view the pages being hosted by the hugo server in your browser for an accurate rendering.

    Markdown Cheat Sheet can be used for the basic page layout. CSS has been applied to the Docsy theme template in order to tweak the final page rendering.

    Create a Pull Request to merge in your changes. See PR Cheat Sheet Making coding changes The Ortelius code base is stored across multiple repositories. Ortelius was originally written as a Java Servlet application running under Tomcat. The front end code is in Java Script using JQuery and JQuery Plugins. The backend code is Java that accesses the Postgres database via JDBC driver. The Ortelius Deployment Engine is written in C++. Plugins to CI tools are written in Python and Groovy.

    New enhancements are being architected to follow the microservice implementation practices. These new microservices are written in Python or Golang and have their own separate repositories.

    The goal is to move from the monolithic implementation, to hybrid and then to a pure microservice based implementation.

    The Java backend code is easiest worked on using the Eclipse IDE, where as the other code can be handled with any editor such as Visual Studio Code.

    A Postgres database needs to be installed for Ortelius to persist its data. Ortelius will create the necessary database tables on startup.

    Steps Fork the ortelius/ortelius to your GitHub account if you are working on the monolithic backend or frontend JS code, otherwise, for the Ortelius microservice repo.

    Clone the new repo to your computer.

    Make the coding changes with your favorite editor.

    The monolithic code can be run and debug natively in Eclipse since a Tomcat Server using a connection to your local Postgres database.

    The microservice code can be run and debugged natively in your editor. It will need to connect to the database over OBDC.

    Create a Pull Request to merge in your changes. See PR Cheat Sheet

    Creating Videos Videos are hosted on the Ortelius Youtube Channel. Please contact one of the chairs to get access to upload to the channel.

    Camtasia for Windows or HitFilm Express for OS/X can be used to edit the videos. Training videos should be edited to remove any stumbles or pauses.

    Videos Requirements:

    Must include the Ortelius Opening and Closing Clips. Resolution of 1040p (1920 x 1080) when possible. Added to appropriate YouTube playlist. Project Management Trello Kanban Board for Ortelius is used to track tasks spanning multiple SIGs and development efforts. Trello cards will contain links to the GitHub issues where appropriate.

    GitHub Triage Dashboard Triage Dashboard #181 will be added in Q1 2021 to help with issue management.

    GitHub Labels and Tags GitHub issues will be label to help filter and navigate issues.

    Release Numbering Releases ending in ”.0” are major releases and this is where all new features land. Releases ending in another integer, like “0.X.1” and “0.X.2” are dot releases, and these are only going to contain bugfixes. Typically we don’t do dot releases for minor bugfixes (reserving these for larger items), but may occasionally decide to cut dot releases containing a large number of smaller fixes if it’s still a fairly long time before the next release comes out.


  • FLOSS license

    What license(s) is the project released under?


    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

  • Documentation


    Enough for a badge!

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

    https://docs.ortelius.io/guides/


    Enough for a badge!

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

  • Other


    Enough for a badge!

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

    Given only https: URLs.


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

    Enough for a badge!

    The project MUST be maintained. [maintained]


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



  • Public version-controlled source repository


    Unknown required information, not enough for a badge.

    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    Unknown required information, not enough for a badge.

    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

  • Unique version numbering


    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Release notes


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Bug-reporting process


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

  • Vulnerability report process


    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Working build system


    Unknown required information, not enough for a badge.

    Ikiwa programu iliyotengenezwa na mradi inahitaji ujenzi wa matumizi, mradi LAZIMA utoe mfumo wa kujenga ambao unaweza kujenga programu kiotomatiki kutoka kwa chanzo-msimbo. [build]

    Unknown required information, not enough for a badge.

    INAPENDEKEZWA kuwa zana za kawaida zitumike kujenga programu. [build_common_tools]

    Unknown required information, not enough for a badge.

    Mradi UNAPASWA kujengwa kwa kutumia zana za FLOSS pekee yake. [build_floss_tools]

  • Automated test suite


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

    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]

  • New functionality testing


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

  • Warning flags


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    The project MUST address warnings. [warnings_fixed]

    Unknown required information, not enough for a badge.

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

  • Secure development knowledge


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

  • Use basic good cryptographic practices

    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.

    Unknown required information, not enough for a badge.

    Programu iliyotengenezwa na mradi LAZIMA itumie, kwa chaguo-msingi, tu itifaki za kriptografia na mifumbo ambazo zimechapishwa hadharani na kukaguliwa na wataalam (ikiwa itifaki za kriptografia na mafumbo imetumika). [crypto_published]

    Unknown required information, not enough for a badge.

    Ikiwa programu iliyotengenezwa na mradi ni programu au maktaba, na kusudi lake la msingi sio kutekeleza usimbuaji, basi INAPASWA tu kuita programu iliyoundwa kihususa kutekeleza kazi za kielelezo; HAIPASWI kutekeleza-upya shughuli hiyo. [crypto_call]

    Unknown required information, not enough for a badge.

    Utendaji wote katika programu iliyotengenezwa na mradi ambayo inategemea usimbuaji LAZIMA iweze kutekelezwa kwa kutumia FLOSS. [crypto_floss]

    Unknown required information, not enough for a badge.

    Mifumo ya usalama ndani ya programu inayozalishwa na mradi LAZIMA itumie kwa msingi keylengths ambazo angalau zinakidhi mahitaji ya chini ya NIST kufikia mwaka wa 2030 (kama ilivyoelezwa mnamo 2012). LAZIMA iwe rahisi kusanidi programu ili keylengths ndogo zimezimwa kabisa. [crypto_keylength]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi INAPASWA kutekeleza kwa ukamilifu usiri wa umbele ya itifaki za makubaliano ya funguo ili funguo la kipindi kilicho tokana na kikao cha vifungo muda-mrefu haziwezi kuridhi mabaya ikiwa mojawapo ya vifunguo vya muda-mrefu imeridhi mabaya katika usoni. [crypto_pfs]

    Unknown required information, not enough for a badge.

    Ikiwa programu iliyotengenezwa na mradi imesababisha uhifadhi wa nywila kwa minajili ya uthibitishaji ya watumiaji wa kutoka nje, nywila LAZIMA zihifadhiwe kwa mficho uliorudiarudia na chumvi kwa kila-mtumiaji kwa kutumia kanuni ya upanuaji (rudiarudia) wa funguo (k.m., Argon2id, Bcrypt, Scrypt, or PBKDF2). Ona pia Kurasadogo ya Uhifadhi wa Nywila la OWASP). [crypto_password_storage]

    Unknown required information, not enough for a badge.

    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi LAZIMA itoe funguo zote za kriptologia na nonces kwa kutumia kitengeneza cha nambari za bahati kuptia kriptologia salama, na ISIWEZE kufanya hivo kutumia vitengenezi zisizo salama kikriptologia. [crypto_random]

  • Secured delivery against man-in-the-middle (MITM) attacks


    Unknown required information, not enough for a badge.

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

    Unknown required information, not enough for a badge.

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

  • Publicly known vulnerabilities fixed


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

  • Other security issues


    Unknown required information, not enough for a badge.

    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]

  • Static code analysis


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

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

  • Dynamic code analysis


    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]

    Unknown required information, not enough for a badge.

    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]


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 TheVestedLeopard and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: TheVestedLeopard.
Entry created on 2022-03-23 05:34:03 UTC, last updated on 2022-03-23 06:17:13 UTC.

Back