wink-nlp

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 6035 is passing Here is how to embed it:

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

        

 Basics 13/17 ●

  • Identification

    winkNLP is a JavaScript library for Natural Language Processing (NLP). Designed specifically to make development of NLP solutions easier and faster, winkNLP is optimized for the right balance of performance and accuracy. The package can handle large amount of raw text at speeds over 525,000 tokens/second. And with a test coverage of ~100%, winkNLP is a tool for building production grade systems with confidence.

  • Prerrequisitos


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

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

    The contribution guidelines including standards are described in the https://github.com/winkjs/wink-nlp/blob/master/CONTRIBUTING.md file.


  • Supervisión del proyecto


    Enough for a badge!

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    Automated mechanism to enforce a CLA (https://gist.github.com/sanjayaksaxena/8b96d3d4f2be6cdc0f28a5839d5a5b2a) is already in place. It uses CLA Assistant for automation; refer to https://cla-assistant.io/winkjs/wink-nlp


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    It is defined in https://github.com/winkjs/wink-nlp/blob/master/CONTRIBUTING.md under the section on Governance.


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    It is defined at https://github.com/winkjs/wink-nlp/blob/master/CODE_OF_CONDUCT.md


    Enough for a badge!

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    It is defined in https://github.com/winkjs/wink-nlp/blob/master/CONTRIBUTING.md under the section on Governance.


    Unknown required information, not enough for a badge.

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    Unknown required information, not enough for a badge.

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    It is outlined at https://github.com/winkjs/wink-nlp/blob/master/ROADMAP.md


    Unknown required information, not enough for a badge.

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    Unknown required information, not enough for a badge.

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    Getting started page at https://winkjs.org/wink-nlp/getting-started.html URL explains how to get started quickly followed by a step-by-step deep dive into the concepts in the following section.


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    winkNLP strives to keep project documentation is updated promptly with every release and code examples are tested. Github issues are used to raise and track such issues; for example refer to https://github.com/winkjs/wink-nlp/issues/9 — so far this is the only issue reported, which was fixed promptly.


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    All badges including the openSSF best practices badge are displayed at the top of the README file; refer to https://github.com/winkjs/wink-nlp#readme for details.


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    Since this a Natural Language Processing library/package targeted for developers and it is not an end user tool therefore this is not applicable; refer to its README at https://github.com/winkjs/wink-nlp#readme


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    Since this a Natural Language Processing library/package targeted for developers and it is not an end user tool therefore this is not applicable; refer to its README at https://github.com/winkjs/wink-nlp#readme


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store 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). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    This a Natural Language Processing library/package targeted for developers and is not required to store any sensitive information — refer to its documentation at https://winkjs.org/wink-nlp/getting-started.html


  • Versiones anteriores


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    So far it has maintained full backward compatibility i.e. no breaking change — refer to https://github.com/winkjs/wink-nlp/releases — in event of any future breaking change, guidelines for upgrades will be clearly documented with its link in the release notes.


  • Bug-reporting process


    Enough for a badge!

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

    GitHub's issues at https://github.com/winkjs/wink-nlp/issues is the place where bugs can be reported and tracked.


  • Proceso de informe de vulnerabilidad


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    Refer to https://snyk.io/vuln/npm:wink-nlp


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    Defined in https://github.com/winkjs/wink-nlp/blob/master/SECURITY.md


  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]

    The coding guidelines are defined in the CONTRIBUTING.md file at https://cheatsheetseries.owasp.org/cheatsheets/Nodejs_Security_Cheat_Sheet.html and are automatically enforced via ESLint.


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]

    The coding guidelines are defined in the CONTRIBUTING.md file at https://cheatsheetseries.owasp.org/cheatsheets/Nodejs_Security_Cheat_Sheet.html and are automatically enforced via ESLint.


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]

    The application does not create native binaries. However TravisCI is used to perform all checks such as linting, testing, and code coverage; refer to https://app.travis-ci.com/github/winkjs/wink-nlp URL.


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]

    The application does not create native binaries. However TravisCI is used to perform all checks such as linting, testing, and code coverage; refer to https://app.travis-ci.com/github/winkjs/wink-nlp URL.


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]

    The application does not create native binaries. However TravisCI is used to perform all checks such as linting, testing, and code coverage; refer to https://app.travis-ci.com/github/winkjs/wink-nlp URL.


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    The application does not create native binaries. However TravisCI is used to perform all checks such as linting, testing, and code coverage; refer to https://app.travis-ci.com/github/winkjs/wink-nlp URL. It is developed in Javascript — does not require compilation.


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    It is published at NPM (https://www.npmjs.com/package/wink-nlp) and uses standard "npm install wink-nlp" and "npm uninstall wink-nlp" for installation.


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    It is published at https://www.npmjs.com/package/wink-nlp and follows NPM standard — installation happens in local project directory because it developed in Javascript.


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]

    There are no external dependencies — refer to https://github.com/winkjs/wink-nlp/blob/master/package.json file. The "npm install" of NPM performs the automatic installation.


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    No external dependencies; see https://github.com/winkjs/wink-nlp/blob/master/package.json


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]

    No external dependencies; refer to https://github.com/winkjs/wink-nlp/blob/master/package.json


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    No external dependencies; see https://github.com/winkjs/wink-nlp/blob/master/package.json


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    No external dependencies; see https://github.com/winkjs/wink-nlp/blob/master/package.json


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]

    Over 345 tests are automatically run at every commit using Travis CI — refer to https://travis-ci.com/github/winkjs/wink-nlp — all tests must pass & code coverage should be > 99.5%


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    Regression tests are automatically run; every bug fix would lead to addition of the test cases to the suite — there is a test suite of over 345 test cases refer to https://travis-ci.com/github/winkjs/wink-nlp and also look at https://github.com/winkjs/wink-nlp/tree/master/test


    Enough for a badge!

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]

    It uses https://github.com/istanbuljs/nyc and it is configured to allow/pass following %age covers "branches": 99.5, "lines": 99.5, "functions": 99.5, and "statements": 99.5 — refer to https://github.com/winkjs/wink-nlp/blob/master/.nycrc.json URL. It is triggered automatically during Travis CI build and is tracked by by CoverAll at https://coveralls.io/github/winkjs/wink-nlp?branch=master URL.


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    It is defined at https://github.com/winkjs/wink-nlp/blob/master/CONTRIBUTING.md#testing — requires automated test scripts to be written to ensure >99.5% coverage.


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]

    It is defined at https://github.com/winkjs/wink-nlp/blob/master/CONTRIBUTING.md#testing — requires automated test scripts to be written to ensure >99.5% coverage.


  • Banderas de advertencia


    Enough for a badge!

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    Build automatically fails if these are not addressed.


  • Conocimiento de desarrollo seguro


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

    There is no RBAC as this is a library/package for NLP developers. Its API does not expose any of the internal variables/information to the developer and has a robust exception handling. Its installation follows the standard NPM driven installation process, which is secure.


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

    Enough for a badge!

    The default security mechanisms within the software produced by the project MUST 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]

    Enough for a badge!

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-), and therefore the developer determines what cryptographic algorithms will be applicable.


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-), and therefore the developer determines how authentication credentials and private cryptographic keys are stored/managed.


    Enough for a badge!

    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-).


    Enough for a badge!

    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-) and it does not require any communication natively.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-) and it does not require any communication natively.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-) and it does not require any communication natively.


  • Secure release


    Enough for a badge!

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    All releases winkNLP is directly published on NPM, which adds its PGP signature to package metadata (https://docs.npmjs.com/about-pgp-signatures-for-packages-in-the-public-registry) and ensures secure distribution.


    Enough for a badge!

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    Each version of winkNLP are always tagged on Github using semantic versioning and all the releases of winkNLP is directly published on NPM, which adds its PGP signature to package metadata (https://docs.npmjs.com/about-pgp-signatures-for-packages-in-the-public-registry) and ensures secure distribution.


  • Otros problemas de seguridad


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-) and it does not process end-user inputs directly. It has a robust exception handling process in place for its APIs.


    Enough for a badge!

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    It implements a NLP library targeted for developers (https://github.com/winkjs/wink-nlp#developer-friendly-natural-language-processing-). It is coded in Javascript therefore compiler flags do not apply. It does not use HTTP.


    Unknown required information, not enough for a badge.

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

  • Análisis estático de código


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]

    ESLint is in use in an automated mode and rules are defined in https://github.com/winkjs/wink-nlp/blob/master/.eslintrc.json


  • Dynamic code analysis


    Enough for a badge!

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

    Package is written using Javascript, not C/C++



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

Project badge entry owned by: Sanjaya Kumar Saxena.
Entry created on 2022-05-09 04:10:26 UTC, last updated on 2022-05-25 05:12:17 UTC. Last achieved passing badge on 2022-05-09 09:27:23 UTC.

Back