OpenMRS seeks to be a reliable and trusted application. We also recognize that security incidents can (and do) still happen, and so it's just as important to have effective methods for handling them should they arise.
Where to send Vulnerability reports
Our Security Group
A Security Group currently exists on OpenMRS Talk. Membership is by invitation only and is open to existing members of the OpenMRS community working on security issues. This Security Group automatically receives any messages sent to firstname.lastname@example.org. (See More about Our Security Group below.)
A framework for managing security incidents
To ensure our incident response process is consistent, repeatable and efficient, we have a clearly defined internal framework that covers the steps we need to take at each phase of the incident response process.
1. Receipt of Incident
Community members and concerned parties work with OpenMRS' Security Group in logging, monitoring of our artifacts and infrastructure. The designated mechanisms through which security incidents are reported are:
- By Email: on email@example.com - Emails are automatically posted on the private Security Talk category, where they are immediately available for review & discussion by relevant OpenMRS community members in technical or operational leadership positions.
- On GitHub: you can use the Private Vulnerability Report feature in GitHub here. This helps us leverage GitHub's Security Advisory & CVE tools.
2. Assessment of Incident
Members of the Security Group will review the incident report and determine an incident severity categorization as depicted below:
|Severity Level||Characteristic||Target time to resolve (Days)|
For critical vulnerabilities, it is advised that you patch or upgrade as soon as possible unless you have other mitigating measures in place. For example, a mitigating factor could be if your installation is not accessible from the Internet.
|Low||Vulnerabilities in the low range typically have very little impact on an organization's business. The exploitation of such vulnerabilities usually requires local or physical system access.||1 Year|
Routine security updates will be highlighted in the release notes for each release. If a vulnerability is a critical one (e.g something submitted by an external body), members will receive an email to that effect
3. Activities for containment, eradication, and recovery
The security vulnerabilities group will determine depending on the level of severity of the incident, agree what corrective measures need to be taken to contain the incident, eradicate the underlying causes and start our recovery processes to ensure that operations return to normal. Thus a summary of activities at this stage would include:
- Upon receipt of incident the security vulnerabilities group is activated: Identify an “Owner,” developer, others on the core team
- Minimum a team of 3-5 people can be assigned to a certain vulnerability group i-e ‘Owner’, ‘developer’ and a ‘tester’, 'coordinator' etc.
- The team can be formed by a security management team with discussion to OpenMRS management, based upon previous contributions of members in their concerned (security) area.
- Define a plan of action to be agreed and executed upon.
- We also have access to a range of external experts to assist us with investigating and responding as effectively as possible.
- Work on the fix
- Compliance with the deadlines
- Test and release
- Create an initial draft of the security review and circulate for review
- Deploy to our environments
- Notify the public via OpenMRS Talk
- Vulnerability with its solution and updated fixes be documented properly. (if possible within major other languages also.)
4. Notification to Implementers and the Public
We aim to notify affected community members within 5 business days or without undue delay if their data is involved in an incident or a breach. This might be light on detail at first, but we’ll provide every detail available when it is available. These initial communications will be done directly with the affected party as the matter is being resolved, however, as soon as the security group deems that it is possible to inform a broader audience, such information will be posted to the designated communication channel which is OpenMRS Talk.
Step 1: Set up a DRAFT Security Advisory in GitHub & Request a CVE
Why create Security Advisories in GitHub?
We recommend using GitHub Security Advisories in the relevant repo(s). This is because:
- Easily get a CVE #: GitHub helpfully will assign you a CVE very quickly if you click the "Request CVE" button.
- Help the World: Publishing our advisories on GitHub has a helpful cascading impact. GitHub reviews published security advisories, and upon review, they may use the advisory to send Dependabot alerts to affected repositories and redistribute the advisory through their API and Atom feed.
- Create a DRAFT Security Advisory in the relevant repo. (Any repo admin can do this.)
- Click "Request CVE" when you are happy with the draft advisory contents (don't worry, you can edit them again later after disclosure). GitHub will assign the advisory a CVE within 72hrs (but usually within an hour.) Requesting a CVE for a draft will not disclose the vulnerability.
- Add the CVE number to your Advisory Email and Forum Post. One of the code owners will need to do so.
Step 2: Notify Implementers
- Create and review email text for an Advisory email to implementers. (We like to send out an internal notice to known organizations using our software to give them some time to react before the vulnerability is publicly posted. This helps organizations have a plan on-hand instead of feeling surprised/caught off guard.)
- Request an OpenMRS MailChimp admin to send the Advisory email to all known implementer leads in the Security Advisory tag in MailChimp:Burke Mamlin , Jennifer Antilla , and Ian Bacher have access to this list.) (As of 2022-02,
Step 3: Notify Publicly on Talk and GitHub
After some period of time (e.g. ranging from immediately to 2 weeks, depending on the severity):
- GitHub: Publicize the Security Advisory.
- Talk Forum: Post the Advisory on Talk. Add the tag security-advisory and include a link to the GitHub repo advisory.
- If the issue is High or Critical: A tweet from the OpenMRS Twitter account is also recommended. This can link to the relevant Talk Forum advisory post in case folks have questions.
Notification Format & Sample Template
Security Advisory Format
Contains at a minimum:
- Affected versions (including mentioning EOL’d versions)
- Exact steps on how to fix the problem, and any available workarounds (list exact versions)
- Acknowledgments to people who reported it and fixed it.
Sample Template Here: Sample Template
More about the Security Group
The role of the group is to work with the finder or reporter to resolve the identified vulnerability. It is also tasked to continually review and understand vulnerabilities that are currently occurring within the system either by themselves or via programs such as bug bounties. This group is responsible for identifying the requisite resources needed to address any vulnerabilities addressed.
Scope of activities:
- Identify requisite resources to develop fixes for identified vulnerabilities
- Oversee at least one major vulnerability scan a year and map a corrective action plan to address vulnerabilities identified
Roles within the Security Group:
- Finder (Discoverer/ Reporter) – the individual or organization that identifies the vulnerability
- External group (i.e: Bishop Fox)
- Internally (i.e:bug bounty/Hackerone)
- Manager - An individual with a role of managing the vulnerability process till the fixing and its updated release, appointed by the management of OpenMRS.
- Vendor – the individual or organization that created or maintains the vulnerable product.
- Deployer – the individual or organization that must deploy a patch or take other remediation action
- Release managers who need to include the patch in the ongoing release process
- Coordinator – an individual or organization that facilitates the coordinated response process
- OpenMRS Software Security Lead
- Tester -the individual who tests the updated release, its feedback is taken from the Deployer and documents the fixes finally report it to the "Owner".
Security Vulnerability “Manager” - Roles and Responsibilities
- Deciding (with the core team) which versions should be released
- Ensuring that a developer is working on the problem on a timely fashion
- Ensuring that a release is done as soon as possible
- Create the initial draft of the security advisory and ask for reviews. Create the CVE if relevant.
- Follow the process to release the security advisory
- Ensure all public OpenMRS community environments are updated.
- Follow up on any discussions or questions about the incident.
- Ensuring the documentation of vulnerabilities and their updated solutions to have a review for the next developments.
- Ensuring the proper testing of the Vulnerability fixing by cross-checking by with the pre-vulnerability state and documenting the final report for future use.