Nested Knowledge

Bringing Systematic Review to Life

User Tools

Site Tools


wiki:policies:dev

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:policies:dev [2021/12/17 17:00]
katcow
wiki:policies:dev [2024/01/25 23:02] (current)
katcow
Line 11: Line 11:
 These standards apply to all persons involved in the acquisition, development and maintenance of Nested Knowledge's IT environment and are applicable to all Nested Knowledge systems, including applications/systems developed for the Internet. These standards apply to all persons involved in the acquisition, development and maintenance of Nested Knowledge's IT environment and are applicable to all Nested Knowledge systems, including applications/systems developed for the Internet.
  
-===== III. Policy =====+===== III. Secure Development Policy =====
  
 === Restrictions on Changes to Software Packages === === Restrictions on Changes to Software Packages ===
Line 23: Line 23:
 === Secure Development Environment === === Secure Development Environment ===
  
-Development environments need to be protected against malicious or accidental development and update of code that may create vulnerabilities or compromise confidentiality. If any form of live data is used in development environments it needs to be especially protected and controlled.+Development environments need to be protected against malicious or accidental development and update of code that may create vulnerabilities or compromise confidentiality. Production data is only used in development when a data-dependent bug arises; in these cases, only the relevant data is made available to the development environment, and it is short-lived, being made inaccessible once the issue is resolved.\\ 
 +\\ 
 +Development environments are independent from production, lacking configuration, credentials, and network access to Production services and data.
  
 === Outsourced Development === === Outsourced Development ===
  
-Nested Knowledge must supervise and monitor the activity of outsourced system development. Where system and software development is outsourced either wholly or partly to external parties, the security requirements must be specified in a contract or attached agreement.+Nested Knowledge source code is only accessible to and developed by internal employees.
  
 === Supplier Adherence to SDLC === === Supplier Adherence to SDLC ===
  
-Nested Knowledge writes all its software in house and consumes open source libraries. OSS libraries are verified when they are added as a dependency.+Nested Knowledge employees develop all application code. External platforms (e.g. AWS) may provide architecture, orchestrate deployment of, and execute application code. External libraries (e.g. OSS) are consumed by application code as modules. External providers offer data to code, most typically in the form of an API. External platforms, providers, and libraries are verified with the following: 
 + 
 +  * A review of technical documentation 
 +      * Does the platform/library maintain a release history? 
 +      * Does the platform/library publish their development strategies? Does it conform to typical SDLC standards? 
 +      * Does the solution advertise itself as production ready? 
 +  * A review of update / release history 
 +      * Does the supplier make regular updates for security patches 
 +        * Automate scanning for existing vulnerabilites using NPM vulnerability scanning, the pypi Safety DB, and GitHub vulnerability monitoring. 
 +      * Does the supplier actively maintain the solution? 
 +      * Does the supplier follow a standardized release versioning system? (e.g. SemVer) 
 +        * Are there reports of major version changes that weren't reported as such? 
 +  * Does the solution include a public issue tracker? 
 +      * Are issues (bugs & security vulnerabilities) addressed quickly? 
 +  * Does the solution have a policy and/or history of disclosing vulnerabilities and breaches? 
 +  * When available, code & version history review. 
 +      * Do all commits to the repository leave it in deployable condition? 
 +        * Are all commits reviewed & verified by a maintainer / peer? 
 +      * Is code well structured & organized? Does it compile? Does it have/pass a linter? 
 +      * Are new features / patches developed on branches or external to the main deployment branch? 
 +      * Does the solution minimize & verify its dependencies? 
 + 
 +Per these criteria, the supplier is assessed for risk in inclusion as a dependency to application code.
  
 ==== Testing Procedures ==== ==== Testing Procedures ====
Line 52: Line 76:
 ====== System Design and Architecture ====== ====== System Design and Architecture ======
  
-The Nested Knowledge client application is served by an application server and hydrated by an API server; both of these servers run behind a load balancer. The API server communicates with the Search and ML backend services as well as the database. Certain functions of backend services communicate with external (public) APIs. The frontend servers, services, and database all run in a Vitrual Private Cloud (VPC) for network isolation. The frontend load balancers are exposed to receieve requests from the public internet. The client and server applications communicate with an external service, Auth0, for authentication; all communications with Auth0 are encrypted.+The Nested Knowledge client application is served by an application server and hydrated by an API server; both of these servers run behind a load balancer. The API server communicates with the Search and ML backend services as well as the database. Certain functions of backend services communicate with external (public) APIs. The frontend servers, services, and database all run in a Virtual Private Cloud (VPC) for network isolation. The frontend load balancers are exposed to receive requests from the public internet and are protected with a WAF using AWS's Core Ruleset. The client and server applications communicate with an external service, Auth0, for authentication; all communications with Auth0 are encrypted.
  
-{{  :wiki:policies:figure1-nkarchitecture1.png?nolink&600x400  }}+{{:wiki:policies:nk_architecture_updated.png?600}}
  
 ===== Security Requirements ===== ===== Security Requirements =====
  
-All application data are stored and processed inside the VPC. Data leaving the VPC are either encrypted to the authenticated & authorized client, or, in the case of external providers contain minimal & nonsensitive information (e.g. DOIs for unpaywall, search strings for PubMed). Within the VPC, communications between the database and all services are encrypted.+==== General ====
  
-Nested Knowledge does not manage user passwords or other authorization (handled by [[https://auth0.com/|Auth0]]).+All application data are stored and processed inside the VPC. Data leaving the VPC are either encrypted to the authenticated & authorized client, or, in the case of external providers contain minimal & nonsensitive information (e.g. DOIs for unpaywall, search strings for PubMed). HTTP traffic is served over HTTPS (redirect required); email traffic (through AWS SES) is encrypted from application to sender (TSL), and sender to receiver (TSL). Within the VPC, communications between the database and all services are encrypted. 
 + 
 +==== Authentication ==== 
 + 
 +Nested Knowledge does not manage user passwords or authentication (handled by [[https://auth0.com/|Auth0]] and Auth0 Lock). All communications with Auth0 from the client are encrypted (TSL), ensuring passwords are not communicated in plain text. Passwords stored by Auth0 are similarly salted & encrypted (bcrypt). Communications relayed by the client are similarly encrypted & RSA signed.
  
 ====== Software Applications on NK-Owned Devices ====== ====== Software Applications on NK-Owned Devices ======
  
 Our [[https://wiki.nested-knowledge.com/doku.php?id=wiki:policies:disaster#application_profile|application profile]] in the Business Continuity Plan describes the criticality of software applications used by Nested Knowledge employees on employee-owned devices. Our [[https://wiki.nested-knowledge.com/doku.php?id=wiki:policies:disaster#application_profile|application profile]] in the Business Continuity Plan describes the criticality of software applications used by Nested Knowledge employees on employee-owned devices.
- 
-At this time, Nested Knowledge does not issue personal computers or mobile devices to employees or contractors. 
  
 ====== Vulnerability and Patch Management ====== ====== Vulnerability and Patch Management ======
Line 72: Line 98:
 Nested Knowledge uses automated scanning to identify potential vulnerabilities in our operating environment and software dependencies. The risk of a vulnerability is assessed using the [[https://nvd.nist.gov/vuln-metrics/cvss|CVSS framework]]. Nested Knowledge uses automated scanning to identify potential vulnerabilities in our operating environment and software dependencies. The risk of a vulnerability is assessed using the [[https://nvd.nist.gov/vuln-metrics/cvss|CVSS framework]].
  
-Our cloud services provider (AWS) provides automated vulnerability reports on operating systems & databases running the application. Alerts derived from these reports are addressed by release engineers:+Our cloud services provider (AWS) provides automated vulnerability reports on operating systems & databases running the application. Application vulnerability scanning is performed by SecurityScorecard on an ongoing basis. Alerts derived from these reports are addressed by release engineers:
  
-  * The applicability & risk of the vulnerability is verified. If a vulnerability is deemed nonapplicable or low severity, it is added to our issue tracker. If applicable or medium or high severity, the vulnerability is assigned to an engineer immediately.+  * The applicability & risk of the vulnerability is verified and added to our issue tracker. If a vulnerability is deemed nonapplicable or low severity, it is prioritized amongst other development initiatives. If medium or high severity, the vulnerability is given highest priority, to be addressed by an engineer with next availability.
   * The viability of the recommended patch is assessed.   * The viability of the recommended patch is assessed.
       * Bug fix / minor version patches may be applied with minimal testing.       * Bug fix / minor version patches may be applied with minimal testing.
Line 80: Line 106:
   * The patch is applied during the next scheduled release window. If a vulnerability is deemed high severity, it triggers an immediate release upon review completion.   * The patch is applied during the next scheduled release window. If a vulnerability is deemed high severity, it triggers an immediate release upon review completion.
  
-Our dependency management tools (NPM pip) provide automated vulnerability scanning. Every build in our development environment produces a vulnerability report among dependencies. Alerts derived from these reports are addressed by developers.+Our dependency management tools (NPMpip, apt-get) provide automated vulnerability reporting & patch alerts. Every build in our development environment produces a vulnerability report among dependencies. Alerts derived from these reports are addressed by developers.
  
   * The applicability & risk of the vulnerability is verified. If a vulnerability is deemed nonapplicable or low severity, it is added to our issue tracker. If applicable or medium or high severity, the vulnerability is assigned to an engineer immediately.   * The applicability & risk of the vulnerability is verified. If a vulnerability is deemed nonapplicable or low severity, it is added to our issue tracker. If applicable or medium or high severity, the vulnerability is assigned to an engineer immediately.
-  * The viability of the recommended patch is assessed. Developers will modify the application code as needed to accomodate the patch (e.g. updating to a new API or changing a configuration). All changes are tested and passed through code review.+  * The viability of the recommended patch is assessed. Developers will modify the application code as needed to accommodate the patch (e.g. updating to a new API or changing a configuration). All changes are tested and passed through code review.
       * If the vulnerability lacks a patch, the team may:       * If the vulnerability lacks a patch, the team may:
         * Contribute an upstream patch, for open source dependencies.         * Contribute an upstream patch, for open source dependencies.
         * Mitigate code paths triggering the vulnerability and begin researching alternative dependencies.         * Mitigate code paths triggering the vulnerability and begin researching alternative dependencies.
 +        * Replace or remove the dependency, with application code changes
   * The dependency and/or code change is deployed during the next scheduled release window. If a vulnerability is deemed high severity, it triggers an immediate release upon review completion.   * The dependency and/or code change is deployed during the next scheduled release window. If a vulnerability is deemed high severity, it triggers an immediate release upon review completion.
  
 === Revision History === === Revision History ===
  
-This policy will be reviewed on an annual basis. The next review will be completed by November 30, 2022.+This policy will be updated at least on an annual basis or when a signficant change occurs.
  
 ^Author^Date of Revision/Review^Comments/Description| ^Author^Date of Revision/Review^Comments/Description|
-|K. Cowie|11/15/2021|Draft sent for approval+|K. Cowie|01/24/2023|Reviewed
-|K. Holub|11/18/2021| |+|K. Holub|03/30/2023|Updating vulnerability scanning to include SecurityScorecard|
 |K. Kallmes|11/19/2021|Draft approved| |K. Kallmes|11/19/2021|Draft approved|
 +|P. Olaniran|9/22/2022|Minor Revisions|
 +
 +[[:wiki:policies|Return to Policies]]
  
  
wiki/policies/dev.1639760426.txt.gz · Last modified: 2021/12/17 17:00 by katcow