Skip to content

Security: Christopher-walsh22/parks-reso-api

Security

SECURITY.md

author title description images
kelpisland
Security Best Practices
Learn more on security and privacy requirments when working in an open environment like Github.
../images/shield.png

Security Best Practices

Government employees will want to take particular care to adhere to security and privacy requirements when working on content in an open environment such as GitHub. The Office of the Chief Information Officer (OCIO) provides the IM/IT Standards you are required to follow, and the content you work with on GitHub must conform with the requirements of being labeled as "Public" using the OCIO Information Security Classification Framework.

Open Development Security Basics – Start with good coding practices.

There is a healthy debate in the security community around the use and development of OSS applications and the implications of exposing the code publicly vs keeping it behind closed doors. The debate boils down to the fact that there is no conclusive evidence that deems either Open or Closed source as inherently more secure. It all comes down to the people (the coders) and their willingness to build security into their code. The one thing that coding in the open does for security is that the public scrutiny of a coders work is proven as a motivating factor for "doing it right" from the start.

What does "Doing it Right" mean?

  • Separate Code from Deployment

    Keys, passwords and other secrets must always be stored safely and securely away from source code. This separation of project code from deployed instances of a project is good development practice regardless of whether or not the software itself is shared in public.

  • Circle of Trust

    It’s advisable for large, significant projects to have a private space to discuss security issues and develop a patch. This removes the risk of flagging a vulnerability before a fix has been deployed. This is especially advisable if there’s a small number of participating developers.

  • Review the code

    Sounds obvious but this step has been skipped by every developer in the world at least once. The simple action of having a second set of eyes on the code can avoid many pitfalls before it's too late.

  • Stay up to date on security best practices

    Most languages, platforms and products have best practices for securing applications - find them, follow them and keep current because security is a moving target.

    Here are some examples:

There aren’t any published security advisories