GNU Astronomy Utilities (Gnuastro)

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 971 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 13/13

  • Identification

    The GNU Astronomy Utilities (Gnuastro) is an official GNU package consisting of various programs and library functions for the manipulation and analysis of astronomical data. All the programs share the same basic command-line user interface for the comfort of both the users and developers. Gnuastro is written to comply fully with the GNU coding standards so it integrates finely with the GNU/Linux operating system. This also enables astronomers to expect a fully familiar experience in the source code, building, installing and command-line user interaction that they have seen in all the other GNU software that they use.

    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]

    At the top of the software's main URL (https://www.gnu.org/software/gnuastro/), a short description is given. There is also a list of all the separate programs that the software contains in a link under the top description (it is like GNU Coreutils which builds and installs many programs in one software package).



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

    In the main project webpage (https://www.gnu.org/software/gnuastro/), there are clear titles "Gnuastro mailing lists", "Report a bug", and "Getting involved", with a description under each which contains links for users to easily provide feedback and contribute to the software.



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

    The main webpage has the necessary top-level links. But the full description on the exact workflow is fully described in "Production workflow" section of the manual (https://www.gnu.org/software/gnuastro/manual/html_node/Production-workflow.html), and there is also a "Forking tutorial" section in the manual (https://www.gnu.org/software/gnuastro/manual/html_node/Forking-tutorial.html) with a fully working series of commands and processes necessary to Gnuastro's Git repository, make changes, commit and push them. Also on how to inform us and how to finally pull their work from the merged repository. As you see there, the importance of working on branches is also thoroughly discussed there. Many first time Git users have used this page so far and have made it more and more easier to use. Generally, there is a full "Developing" chapter in the manual (https://www.gnu.org/software/gnuastro/manual/html_node/Developing.html) which is only devoted to guidelines for the developers



    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]

    The Gnuastro manual has a complete section devoted to "Coding conventions" (https://www.gnu.org/software/gnuastro/manual/html_node/Coding-conventions.html). Generally, there is a full "Developing" chapter in the manual (https://www.gnu.org/software/gnuastro/manual/html_node/Developing.html) which is only devoted to guidelines for the developers


  • FLOSS license

    What license(s) is the project released under?



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

    Its copyright is GPL-3.0+ (https://git.savannah.gnu.org/cgit/gnuastro.git/tree/COPYING) The GPL-3.0 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 GPL-3.0 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]

    https://www.gnu.org/software/gnuastro/manual/html_node/index.html#Top

    The documentation is also available in many other formats (for example info' andman' on the command-line, PDF for print, plain text, and HTML). The documentation in all formats is available here: https://www.gnu.org/software/gnuastro/manual/index.html



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

    Gnuastro has both libraries and binaries (programs). In the manual, following the GNU Coding Standards, all programs have a special "Invoking ProgramName" section which gives a few examples commands of how to run the program, followed by the description of options, here are some examples:

    https://www.gnu.org/software/gnuastro/manual/html_node/Invoking-astarithmetic.html https://www.gnu.org/software/gnuastro/manual/html_node/Invoking-astmkcatalog.html

    Also, the API for the library functions are also fully described in the manual, you can see the whole list of APIs in different headers in this link: https://www.gnu.org/software/gnuastro/manual/html_node/Gnuastro-library.html . Here is an example: https://www.gnu.org/software/gnuastro/manual/html_node/World-Coordinate-System.html


  • Other


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

    All webpages are hosted by GNU and support HTTPS, this is the top page: https://www.gnu.org/software/gnuastro/index.html



    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]

    In Gnuastro, we do all development discussions in Savannah: http://savannah.gnu.org/projects/gnuastro/ . There are separate "Support", "Bug" and "Task" trackers. Each issue receives a special ID from Savannah and is classified by the part of Gnuastro that it relates to. It is possible to select issues based on many criteria. For example, here is the bug tracers: http://savannah.gnu.org/bugs/?group=gnuastro (clicking on "Display criteria" close to the top of the page will allow you to select the bugs by many classes). All discussions in all the trackers is also archived in the Gnuastro-devel mailing list ( http://lists.gnu.org/archive/html/gnuastro-devel/ ).



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

    Everything in Gnuastro is currently only in English!



    The project MUST be maintained. [maintained]


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



Gnuastro strives to follow the GNU Coding Standards for high quality code and user interface.

  • Public version-controlled source repository


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

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

    All Git repositories do this.



    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]

    Every commit is given a unique version (based on `git describe'). Before major releases, we release tar-balls in this address: http://alpha.gnu.org/gnu/gnuastro/ . Once this tarball has been sufficiently tested and major bugs fixed do we make an official release. The full versioning of Gnuastro is discussed here: https://www.gnu.org/software/gnuastro/manual/html_node/Version-numbering.html



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

    Gnuastro is version controlled with Git: http://git.savannah.gnu.org/cgit/gnuastro.git


  • Unique version numbering


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

    Gnuastro does have a unique identifier for every commit (based on Git's `describe') and also major releases get a unique tag. For more, please see https://www.gnu.org/software/gnuastro/manual/html_node/Version-numbering.html



    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]

    Gnuastro uses Git tags for major releases, see under the "Tag" title in this link: http://git.savannah.gnu.org/cgit/gnuastro.git

    The Tag is then used for minor releases, as fully described here: https://www.gnu.org/software/gnuastro/manual/html_node/Version-numbering.html


  • Release notes


    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]

    Every major and alpha release of Gnuastro is announced in the `info-gnuastro' mailing list: http://lists.gnu.org/archive/html/info-gnuastro/

    As you can see in each, the announcement comes with a full copy of this release's section in the NEWS file (which is human readable file, even for someone who doesn't know programming or Git). Also, the hashes for the tarballs so users can be sure that what they get is what we distributed.



    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]

    The NEWS file in each release announcement describes all the important known vulnerabilities (bugs) that have been fixed: http://lists.gnu.org/archive/html/info-gnuastro/


  • 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]

    Any anonymous user can post an issue on our "Support tracker": http://savannah.gnu.org/support/?func=additem&group=gnuastro . They can also send mails to bug-gnuastro:a:t:gnu.org or help-gnuastro:a:t:gnu.org.



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

    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 full list of solved and unsolved bugs are available in the main project management webpage: http://savannah.gnu.org/bugs/?group=gnuastro



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

    All the enhancements and their discussions are listed in our task tracker: http://savannah.gnu.org/task/?group=gnuastro



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

    All the development discussions from all our trackers are distributed and archived through the gnuastro-devel mailing list: http://lists.gnu.org/archive/html/gnuastro-devel/


  • Vulnerability report process


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

    There is a "Report a Bug" section in out top webpage: https://www.gnu.org/software/gnuastro/#bug which discusses the process to inform us of any vulnerability.



    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]

    Gnuastro is not a security software. If private issues must be discussed, users are encouraged to contact the maintainer directory (maintainer information is given on main webpage: https://www.gnu.org/software/gnuastro/



    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]

    From the main project management webpage (https://savannah.gnu.org/projects/gnuastro/), it is visible that many bugs (all the important ones) are fixed almost immediately (as of mid May 2017: only 13 open from a total of 59). The rest are minor and will be fixed when the developers have time.


  • Working build system


    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]

    Gnuastro uses the GNU Build System (./configure',make', make check',make install'): https://www.gnu.org/software/gnuastro/manual/html_node/Quick-start.html



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

    Gnuastro uses the GNU Build System (./configure',make', make check',make install'): https://www.gnu.org/software/gnuastro/manual/html_node/Quick-start.html



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

    Gnuastro uses the GNU Build System (./configure',make', make check',make install'): https://www.gnu.org/software/gnuastro/manual/html_node/Quick-start.html


  • 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]

    Gnuastro currently has 51 tests that are executed when the user runs `make check'.



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

    Gnuastro uses `make check'.



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

    It covers most of the basic operations, it would be ideal to cover all, but the developers don't have enough resources to invest in them, so we have designed it based on the major features.



    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]

    Before each commit is pushed to the main repo a `make distcheck' is done and everything is checked. On major releases, it is tested as part of GNU Guix: http://hydra.gnu.org/job/gnu/master/gnuastro-0.2.x86_64-linux and Debian: https://packages.debian.org/sid/science/gnuastro . We do plan to include automatic continuous integration in the future.


  • 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]

    With every major features, a test is added in the tests/' directory and thus tomake check'.



    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]


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

    In the "Developing" chapter of the Gnuastro book, we try to discuss this with the developers or those interested: https://www.gnu.org/software/gnuastro/manual/html_node/Test-scripts.html


  • Warning flags


    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]

    Gnuastro is built with the -Wall' flag: see AM_INIT_AUTOMAKE in ourconfigure.ac': http://git.savannah.gnu.org/cgit/gnuastro.git/tree/configure.ac



    The project MUST address warnings. [warnings_fixed]

    We fix any compiler warnings that we see or are reported to us to have a clean build.



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

    That is correct, For example this commit: http://git.savannah.gnu.org/cgit/gnuastro.git/commit/?id=195fae5be4f3 where several compiler warning were reported to us and we immediately addressed them.


  • Secure development knowledge


    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]

    While the primary developer is an astronomer (not a security expert), Gnuastro has been designed with all the issues in this list in mind and actually applies all of them. Generally, in no time does Gnuastro need special privileges.



    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]

    Gnuastro does not deal with these kinds of operations.


  • 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.

    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]


    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]


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


    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]


    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 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]


    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]


    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]


    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


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


    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


    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]


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

  • Other security issues


    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


    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]

    We will look into this and try to find a good static code analysis method.



    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]

    We haven't implemented a static code analyzer yer.



    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]


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

    We will implement static code analysis in the future.


  • 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]


    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]

    We use Valgrind for checking the dynamic memory allocations in Gnuastro.



    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]

    We check every allocation and it is only used if a non-NULL pointer is returned by malloc' orcalloc'.



    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]

    We fix such issues immediately.



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

Project badge entry owned by: Mohammad Akhlaghi.
Entry created on 2017-05-17 17:02:27 UTC, last updated on 2017-05-17 18:27:49 UTC.

Back