This site is the archived OWASP Foundation Wiki and is no longer accepting Account Requests.
To view the new OWASP Foundation website, please visit https://owasp.org

Difference between revisions of "OWASP API Security Project"

From OWASP
Jump to: navigation, search
m (→‎What is the OWASP API Security Project?)
(→‎Contributors)
 
(47 intermediate revisions by 4 users not shown)
Line 5: Line 5:
 
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
 
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
−
| valign="top"  style="border-right: 1px dotted gray;padding-right:25px;" |
+
| style="border-right: 1px dotted gray;padding-right:25px;" valign="top" |
  
−
==OWASP API Security Project==
+
==What is API Security?==
  
−
This project seeks to address the ever-increasing number of organizations that are deploying potentially sensitive APIs as part of their software offerings. These APIs are used for internal tasks and to interface with third parties. Unfortunately, many APIs do not undergo the rigorous security testing that would render them secure from attack.
+
A foundational element of innovation in today’s app-driven world is the API. From banks, retail and transportation to IoT, autonomous vehicles and smart cities, APIs are a critical part of modern mobile, SaaS and web applications and can be found in customer-facing, partner-facing and internal applications. By nature, APIs expose application logic and sensitive data such as Personally Identifiable Information (PII) and because of this have increasingly become a target for attackers. Without secure APIs, rapid innovation would be impossible.  
  
−
The OWASP API Security Project seeks to provide value to software developers and security assessors by underscoring the potential risks in insecure APIs and illustrating how these risks may be mitigated. In order to facilitate this goal, the OWASP API Security Project will create and maintain a '''Top 10 API Security Risks''' document, as well as a '''documentation portal''' for best practices when creating or assessing APIs.
+
API Security focuses on strategies and solutions to understand and mitigate the unique vulnerabilities and security risks of Application Programming Interfaces (APIs).
  
−
==Description==
+
==API Security Top 10 is Here!==
  
−
While working as developers or information security consultants, many people have encountered APIs as part of a project. While there are some resources to help create and evaluate these projects (such as the OWASP REST Security Cheat Sheet), there has not be a comprehensive security project designed to assist builders, breakers, and defenders in the community.
+
Here is a sneak peek of the 2019 version:
  
−
This project aims to create:
+
{| class="wikitable"
−
 
+
|-
−
* The OWASP Top Ten API Security Risks document, which can easily underscore the most common risks in the area.
+
| API1 || Broken Object Level Authorization || APIs tend to expose endpoints that handle object identifiers, creating a wide attack surface Level Access Control issue. Object level authorization checks should be considered in every function that accesses a data source using an input from the user.
−
* Create a documentation portal for developers to build APIs in a secure manner.
+
|-
−
* Work with the security community to maintain living documents that evolve with security trends.
+
| API2 || Broken User Authentication || Authentication mechanisms are often implemented incorrectly, allowing attackers to compromise authentication tokens or to exploit implementation flaws to assume other user's identities temporarily or permanently. Compromising system's ability to identify the client/user, compromises API security overall.
 +
|-
 +
| API3 || Excessive Data Exposure || Looking forward to generic implementations, developers tend to expose all object properties without considering their individual sensitivity, relying on clients to perform the data filtering before displaying it to the user.
 +
|-
 +
| API4 || Lack of Resources & Rate Limiting || Quite often, APIs do not impose any restrictions on the size or number of resources that can be requested by the client/user. Not only can this impact the API server performance, leading to Denial of Service (DoS), but also leaves the door open to authentication flaws such as brute force.
 +
|-
 +
| API5 || Broken Function Level Authorization || Complex access control policies with different hierarchies, groups, and roles, and an unclear separation between administrative and regular functions, tend to lead to authorization flaws. By exploiting these issues, attackers gain access to other users’ resources and/or administrative functions.
 +
|-
 +
| API6 || Mass Assignment || Binding client provided data (e.g., JSON) to data models, without proper properties filtering based on a whitelist, usually lead to Mass Assignment. Either guessing objects properties, exploring other API endpoints, reading the documentation, or providing additional object properties in request payloads, allows attackers to modify object properties they are not supposed to.
 +
|-
 +
| API7 || Security Misconfiguration || Security misconfiguration is commonly a result of unsecure default configurations, incomplete or ad-hoc configurations, open cloud storage, misconfigured HTTP headers, unnecessary HTTP methods, permissive Cross-Origin resource sharing (CORS), and verbose error messages containing sensitive information.
 +
|-
 +
| API8 || Injection || Injection flaws, such as SQL, NoSQL, Command Injection, etc., occur when untrusted data is sent to an interpreter as part of a command or query. The attacker's malicious data can trick the interpreter into executing unintended commands or accessing data without proper authorization.
 +
|-
 +
| API9 || Improper Assets Management || APIs tend to expose more endpoints than traditional web applications, making proper and updated documentation highly important. Proper hosts and deployed API versions inventory also play an important role to mitigate issues such as deprecated API versions and exposed debug endpoints.
 +
|-
 +
| API10 || Insufficient Logging & Monitoring || Insufficient logging and monitoring, coupled with missing or ineffective integration with incident response, allows attackers to further attack systems, maintain persistence, pivot to more systems to tamper with, extract, or destroy data. Most breach studies demonstrate the time to detect a breach is over 200 days, typically detected by external parties rather than internal processes or monitoring.
 +
|}
  
 
==Licensing==
 
==Licensing==
  
−
'''The OWASP API Security Project documents are free to use!
+
'''The OWASP API Security Project documents are free to use!'''
  
 
The OWASP API Security Project is licensed under the http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 license], so you can copy, distribute and transmit the work, and you can adapt it, and use it commercially, but all provided that you attribute the work and if you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.
 
The OWASP API Security Project is licensed under the http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 license], so you can copy, distribute and transmit the work, and you can adapt it, and use it commercially, but all provided that you attribute the work and if you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.
  
−
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
+
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE --><!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
−
| valign="top"  style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
+
| style="padding-left:25px;width:200px;" valign="top" |
 +
 
 +
== Project Leaders ==
 +
 
 +
* [[User:ErezYalon|Erez Yalon]]
 +
* [[User:Inon|Inon Shkedy]]
 +
'''Main Collaborator'''
 +
* [[User:PauloASilva|Paulo Silva]]
 +
 
 +
== Quick Links ==
 +
 
 +
[https://groups.google.com/a/owasp.org/d/forum/api-security-project Google Group]
 +
 
 +
[https://github.com/OWASP/API-Security GitHub]
  
−
== What is the this project? ==
+
[https://github.com/OWASP/API-Security/raw/master/2019/en/dist/owasp-api-security-top-10.pdf API Security Top 10 2019 (PDF)]
  
−
The OWASP API Security Project seeks to deliver actionable documentation on creating and deploying verifiably secure web APIs, as well as illustrating the major risks and shortfalls that APIs may encounter. By helping developers create resilient software, and helping assessors understand the subtle risks an API may entail, the goal of this project is to bring security to an increasingly programmatic world.
+
== News ==
  
−
== Presentation ==
+
=== Dec 26, 2019 ===
  
−
The OWASP API Security Project will be presented in 2016.
+
OWASP API Security Top 10 2019 stable version release.
  
−
== Project Leader ==
+
=== Sep 30, 2019 ===
  
−
* [https://www.owasp.org/index.php/User:David_Shaw David Shaw]
+
The RC of API Security Top-10 List was published during [https://ams.globalappsec.org/ OWASP Global AppSec Amsterdam]
  
−
== Related Projects ==
+
[[File:API Security Top 10 RC - Global AppSec AMS.pdf|thumb|Presentation - API Security Top 10 RC - Global AppSec AMS]]
  
−
* [[REST_Security_Cheat_Sheet]]
+
=== Sep 13, 2019 ===
−
* [https://www.owasp.org/index.php/Category:OWASP_Enterprise_Security_API Enterprise Security API]
 
  
−
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
+
The RC of API Security Top-10 List was published during [https://dc.globalappsec.org/ OWASP Global AppSec DC]
−
| valign="top"  style="padding-left:25px;width:200px;" |
 
  
−
== Quick Download ==
+
[[File:API Security Top 10 RC.pdf|thumb|Presentation - API Security Top 10 RC]]
  
−
Once API Security documents are created, they will be available for direct download here.
+
=== May 30, 2019 ===
  
−
== News and Events ==
+
The API Security Project was Kicked-Off during [https://telaviv.appsecglobal.org/ OWASP Global AppSec Tel Aviv]
  
−
There has not yet been press coverage of this project.
+
[[File:OWASP APIs Security Project Kick Off.pdf]]
  
 
==Classifications==
 
==Classifications==
Line 64: Line 92:
 
   {| width="200" cellpadding="2"
 
   {| width="200" cellpadding="2"
 
   |-
 
   |-
−
   | align="center" valign="top" width="50%" rowspan="3"| [[File:New projects.png|100px|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Incubator_Projects]]
+
   | rowspan="3" width="50%" valign="top" align="center" | [[File:New projects.png|100px|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Incubator_Projects]]
−
   | align="center" valign="top" width="50%"| [[File:Owasp-builders-small.png|link=]]   
+
   | width="50%" valign="top" align="center" | [[File:Owasp-builders-small.png|link=]]   
 
   |-
 
   |-
−
   | align="center" valign="top" width="50%"| [[File:Owasp-breakers-small.png|link=]]
+
   | width="50%" valign="top" align="center" | [[File:Owasp-breakers-small.png|link=]]
 
   |-
 
   |-
−
   | align="center" valign="top" width="50%"| [[File:Owasp-defenders-small.png|link=]]
+
   | width="50%" valign="top" align="center" | [[File:Owasp-defenders-small.png|link=]]
 
   |-
 
   |-
−
   | colspan="2" align="center" | [[File:Cc-button-y-sa-small.png|link=http://creativecommons.org/licenses/by-sa/3.0/]]  
+
   | colspan="2" align="center" | [[File:Cc-button-y-sa-small.png|link=http://creativecommons.org/licenses/by-sa/3.0/]]  
 
   |-
 
   |-
−
   | colspan="2" align="center" | [[File:Project_Type_Files_DOC.jpg|link=]]   
+
   | colspan="2" align="center" | [[File:Project_Type_Files_DOC.jpg|link=]]   
 
   |}
 
   |}
  
 
|}
 
|}
  
−
=FAQs=
+
= Acknowledgments =
 +
 
 +
==Founders==
 +
* Erez Yalon
 +
* Inon Shkedy
  
−
==How can I participate in your project?==
+
==Sponsors==
−
This project welcomes contributors of all sorts. The easiest way to get involved is to contact the Project Leader, and indicate that you're willing to help.
+
[[File:Checkmarx-Logo-Horizontal-black-512px.png|left|Checkmarx Logo]]
 +
[[File:SALT Logo.jpg|512px|none|left|SALT Logo]]
  
−
==What type of contributors are you seeking?==
+
==Main Maintainer==
−
We're currently looking for software developers who have experience building out resilient APIs, and security assessors who have assessed APIs. This project is currently in the "research" stage, meaning that the more you can contribute to building out the project, the better!
+
* Paulo Silva
  
−
==Can I still participate if I'm not a developer/assessor?==
+
==Contributors==
−
Sure -- we just need to figure out the correct role. If you're strong with technical writing, that would be great; if there are other skill sets you think you can bring to the table, please let us know.
+
007divyachawla, Abid Khan, Adam Fisher, anotherik, bkimminich, caseysoftware, Chris Westphal, dsopas, DSotnikov, emilva, ErezYalon, flascelles, Guillaume Benats, IgorSasovets, Inonshk, JonnySchnittger, jmanico, jmdx, Keith Casey, kozmic, LauraRosePorter, Matthieu Estrade, nathanawmk, PauloASilva, pentagramz, philippederyck, pleothaud, r00ter, Raj kumar, Sagar Popat, Stephen Gates, thomaskonrad, xycloops123
  
−
= Acknowledgements =
+
= Join =
  
−
==Contributors==
+
== Google Group ==
 +
Join the discussion on the [https://groups.google.com/a/owasp.org/d/forum/api-security-project OWASP API Security Project Google group].
 +
 
 +
This is the best place to introduce yourself, ask questions, suggest and discuss any topic that is relevant to the project.
  
−
The OWASP API Security Project is small, but will be maintained by volunteers. If you'd like to volunteer, please contact the Project Leader.
+
== GitHub ==
 +
The project is maintained in the [https://github.com/OWASP/API-Security OWASP API Security Project repo].
  
−
The creator of this project and current Project Leader is [https://www.owasp.org/index.php/User:David_Shaw David Shaw].
+
'''The latest changes are under the [https://github.com/OWASP/API-Security/tree/develop develop branch].'''
  
−
= Road Map and Getting Involved =
+
Feel free to open or solve an [https://github.com/OWASP/API-Security/issues issue].
  
−
The roadmap for this project is straightforward: we'll begin by conducting research and seeking feedback from developers and security auditors on the problems they most frequently encounter via web-based APIs. We'll create, from this research, the OWASP Top Ten API Security Risks, a sub-project of the API Security Project. Once this document is created (and maintained), we will also create guidelines in order to demonstrate each of the risks (as well as other, non-top-ten risks) and illustrate how to prevent them.
+
Ready to contribute directly into the repo? Great! Just make you you read the [https://github.com/OWASP/API-Security/blob/master/CONTRIBUTING.md How to Contribute guide].
  
−
'''Q4 2015 Priorities'''
+
= Road Map =
−
* Establish the project, including mailing list, wiki page, etc.
 
−
* Conduct PR-related activities to involve the community at large.
 
−
* Conduct research to understand widely-accepted risks in APIs
 
−
* Compile Top Ten API Security Risks
 
  
−
We'd love for you to get involved with this project if you feel you can contribute! Please contact the Project Leader to better understand how you can volunteer.
+
==Planned Projects==
 +
* API Security Top 10
 +
* API Security Cheat Sheet
 +
* crAPI ('''C'''ompletely '''R'''idiculous '''API''' - an intentionally vulnerable API project)
  
−
=Project About=
+
==Road Map==
 +
[[File:Roadmap.png|left|Roadmap]]
  
 
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 
__NOTOC__ <headertabs />  
 
__NOTOC__ <headertabs />  
  
−
Please refer to the primary wiki page to learn about this project.
+
[[Category:OWASP Project]]   
−
 
+
[[Category:OWASP_Builders]]  
−
[[Category:OWASP Project]]  [[Category:OWASP_Builders]] [[Category:OWASP_Breakers]] [[Category:OWASP_Defenders]]  [[Category:OWASP_Document]]
+
[[Category:OWASP_Breakers]]  
 +
[[Category:OWASP_Defenders]]   
 +
[[Category:OWASP_Document]]

Latest revision as of 10:39, 6 January 2020

OWASP Project Header.jpg

What is API Security?

A foundational element of innovation in today’s app-driven world is the API. From banks, retail and transportation to IoT, autonomous vehicles and smart cities, APIs are a critical part of modern mobile, SaaS and web applications and can be found in customer-facing, partner-facing and internal applications. By nature, APIs expose application logic and sensitive data such as Personally Identifiable Information (PII) and because of this have increasingly become a target for attackers. Without secure APIs, rapid innovation would be impossible.

API Security focuses on strategies and solutions to understand and mitigate the unique vulnerabilities and security risks of Application Programming Interfaces (APIs).

API Security Top 10 is Here!

Here is a sneak peek of the 2019 version:

API1 Broken Object Level Authorization APIs tend to expose endpoints that handle object identifiers, creating a wide attack surface Level Access Control issue. Object level authorization checks should be considered in every function that accesses a data source using an input from the user.
API2 Broken User Authentication Authentication mechanisms are often implemented incorrectly, allowing attackers to compromise authentication tokens or to exploit implementation flaws to assume other user's identities temporarily or permanently. Compromising system's ability to identify the client/user, compromises API security overall.
API3 Excessive Data Exposure Looking forward to generic implementations, developers tend to expose all object properties without considering their individual sensitivity, relying on clients to perform the data filtering before displaying it to the user.
API4 Lack of Resources & Rate Limiting Quite often, APIs do not impose any restrictions on the size or number of resources that can be requested by the client/user. Not only can this impact the API server performance, leading to Denial of Service (DoS), but also leaves the door open to authentication flaws such as brute force.
API5 Broken Function Level Authorization Complex access control policies with different hierarchies, groups, and roles, and an unclear separation between administrative and regular functions, tend to lead to authorization flaws. By exploiting these issues, attackers gain access to other users’ resources and/or administrative functions.
API6 Mass Assignment Binding client provided data (e.g., JSON) to data models, without proper properties filtering based on a whitelist, usually lead to Mass Assignment. Either guessing objects properties, exploring other API endpoints, reading the documentation, or providing additional object properties in request payloads, allows attackers to modify object properties they are not supposed to.
API7 Security Misconfiguration Security misconfiguration is commonly a result of unsecure default configurations, incomplete or ad-hoc configurations, open cloud storage, misconfigured HTTP headers, unnecessary HTTP methods, permissive Cross-Origin resource sharing (CORS), and verbose error messages containing sensitive information.
API8 Injection Injection flaws, such as SQL, NoSQL, Command Injection, etc., occur when untrusted data is sent to an interpreter as part of a command or query. The attacker's malicious data can trick the interpreter into executing unintended commands or accessing data without proper authorization.
API9 Improper Assets Management APIs tend to expose more endpoints than traditional web applications, making proper and updated documentation highly important. Proper hosts and deployed API versions inventory also play an important role to mitigate issues such as deprecated API versions and exposed debug endpoints.
API10 Insufficient Logging & Monitoring Insufficient logging and monitoring, coupled with missing or ineffective integration with incident response, allows attackers to further attack systems, maintain persistence, pivot to more systems to tamper with, extract, or destroy data. Most breach studies demonstrate the time to detect a breach is over 200 days, typically detected by external parties rather than internal processes or monitoring.

Licensing

The OWASP API Security Project documents are free to use!

The OWASP API Security Project is licensed under the http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 license], so you can copy, distribute and transmit the work, and you can adapt it, and use it commercially, but all provided that you attribute the work and if you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.

Project Leaders

Main Collaborator

Quick Links

Google Group

GitHub

API Security Top 10 2019 (PDF)

News

Dec 26, 2019

OWASP API Security Top 10 2019 stable version release.

Sep 30, 2019

The RC of API Security Top-10 List was published during OWASP Global AppSec Amsterdam

File:API Security Top 10 RC - Global AppSec AMS.pdf

Sep 13, 2019

The RC of API Security Top-10 List was published during OWASP Global AppSec DC

File:API Security Top 10 RC.pdf

May 30, 2019

The API Security Project was Kicked-Off during OWASP Global AppSec Tel Aviv

File:OWASP APIs Security Project Kick Off.pdf

Classifications

New projects.png Owasp-builders-small.png
Owasp-breakers-small.png
Owasp-defenders-small.png
Cc-button-y-sa-small.png
Project Type Files DOC.jpg

Founders

  • Erez Yalon
  • Inon Shkedy

Sponsors

Checkmarx Logo
SALT Logo

Main Maintainer

  • Paulo Silva

Contributors

007divyachawla, Abid Khan, Adam Fisher, anotherik, bkimminich, caseysoftware, Chris Westphal, dsopas, DSotnikov, emilva, ErezYalon, flascelles, Guillaume Benats, IgorSasovets, Inonshk, JonnySchnittger, jmanico, jmdx, Keith Casey, kozmic, LauraRosePorter, Matthieu Estrade, nathanawmk, PauloASilva, pentagramz, philippederyck, pleothaud, r00ter, Raj kumar, Sagar Popat, Stephen Gates, thomaskonrad, xycloops123

Google Group

Join the discussion on the OWASP API Security Project Google group.

This is the best place to introduce yourself, ask questions, suggest and discuss any topic that is relevant to the project.

GitHub

The project is maintained in the OWASP API Security Project repo.

The latest changes are under the develop branch.

Feel free to open or solve an issue.

Ready to contribute directly into the repo? Great! Just make you you read the How to Contribute guide.

Planned Projects

  • API Security Top 10
  • API Security Cheat Sheet
  • crAPI (Completely Ridiculous API - an intentionally vulnerable API project)

Road Map

Roadmap
Retrieved from "https://wiki.owasp.org/index.php?title=OWASP_API_Security_Project&oldid=256547"