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 SaaS Rest API Secure Guide"

From OWASP
Jump to: navigation, search
(→‎REST API Builder)
 
(12 intermediate revisions by the same user not shown)
Line 59: Line 59:
 
#Compliance
 
#Compliance
 
#Host/Platform Security
 
#Host/Platform Security
−
 
  
 
==Licensing==
 
==Licensing==
Line 76: Line 75:
  
 
== Presentation ==
 
== Presentation ==
−
 
+
<span style="color:#ff0000">
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
 
 
 
*To be updated
 
*To be updated
−
 
+
</span>
  
 
== Project Leader ==
 
== Project Leader ==
Line 93: Line 90:
 
* [[REST Security Cheat Sheet]]
 
* [[REST Security Cheat Sheet]]
  
−
 
−
== Openhub ==
 
−
 
−
* [https://www.openhub.net/orgs/OWASP OWASP Project Openhub]
 
−
 
−
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE -->
 
 
| valign="top"  style="padding-left:25px;width:200px;" |
 
| valign="top"  style="padding-left:25px;width:200px;" |
  
Line 105: Line 96:
 
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
<span style="color:#ff0000">
 
<span style="color:#ff0000">
−
This is where you can link to your repository.
+
To be updated
 
</span>
 
</span>
  
−
The home of the OWASP Security Principles is on [https://github.com/OWASP/Security-Principles GitHub.] You are encourged to fork, edit and push your changes back to the project through git or edit the project directly on github.
 
−
 
−
However, if you like you may also download the master repository from the following links:
 
−
* [https://github.com/OWASP/Security-Principles/zipball/master .zip file.]
 
−
* [https://github.com/OWASP/Security-Principles/tarball/master .tgz file.]
 
  
 
== News and Events ==
 
== News and Events ==
 +
* [June 2016] Project Initiated. Call for Contributors.
  
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
== Classifications ==
−
<span style="color:#ff0000">
 
−
This is where you can link to press your project has been a part of. Appropriate press includes: Project Leader interviews, articles written about your project, and videos about your project.
 
−
</span>
 
−
 
 
−
* [20 Nov 2013] News 2
 
−
* [30 Sep 2013] News 1
 
−
 
 
−
== In Print ==
 
−
 
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
This is where you place links to where your project product can be downloaded or purchased, in the case of a book.
 
−
</span>
 
−
 
 
−
This project can be purchased as a print on demand book from Lulu.com
 
−
 
 
−
==Classifications==
 
−
 
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
Here is where you can let the community know what project stage your project is currently in, whether the project is a builder, breaker, or defender project, and what type of project you are running.
 
−
</span>
 
−
 
 
 
   {| width="200" cellpadding="2"
 
   {| width="200" cellpadding="2"
 
   |-
 
   |-
Line 153: Line 117:
  
 
|}
 
|}
 +
=REST API Builder=
 +
== Summary ==
 +
 +
=REST API Consumer=
 +
=REST API Platform=
 +
=Top 10 Mapping=
  
 
=FAQs=
 
=FAQs=
−
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
Many projects have "Frequently Asked Questions" documents or pages. However, the point of such a document is not the questions. ''The point of a document like this are the '''answers'''''. The document contains the answers that people would otherwise find themselves giving over and over again. The idea is that rather than laboriously compose and post the same answers repeatedly, people can refer to this page with pre-prepared answers. Use this space to communicate your projects 'Frequent Answers.'
 
−
</span>
 
−
 
  
 
==How can I participate in your project?==
 
==How can I participate in your project?==
−
All you have to do is make the Project Leader's aware of your available time to contribute to the project. It is also important to let the Leader's know how you would like to contribute and pitch in to help the project meet it's goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key.  
+
All you have to do is make the Project Leader's aware of your available time to contribute to the project. It is also important to let the Leader's know how you would like to contribute and pitch in to help the project meet it's goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key. Project Lead contact [https://www.owasp.org/index.php/User:Tony_Hsu_HsiangChih Tony Hsu] [mailto:hsiang_chih@yahoo.com @]
  
 
==If I am not a programmer can I participate in your project?==
 
==If I am not a programmer can I participate in your project?==
Line 171: Line 135:
  
 
==Contributors==
 
==Contributors==
−
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
The success of OWASP is due to a community of enthusiasts and contributors that work to make our projects great. This is also true for the success of your project.
 
−
Be sure to give credit where credit is due, no matter how small! This should be a brief list of the most amazing people involved in your project.
 
−
Be sure to provide a link to a complete list of all the amazing people in your project's community as well.
 
−
</span>
 
−
 
−
The OWASP Security Principles project is developed by a worldwide team of volunteers. A live update of project  [https://github.com/OWASP/Security-Principles/graphs/contributors contributors is found here].
 
  
 
The first contributors to the project were:
 
The first contributors to the project were:
  
−
* [https://www.owasp.org/index.php/User:Dennis_Groves Dennis Groves]
+
* [https://www.owasp.org/index.php/User:Tony_Hsu_HsiangChih Tony Hsu]
−
* [https://github.com/sublimino Andrew Martin]
 
−
* [https://github.com/Lambdanaut Josh Thomas]
 
−
* '''YOUR NAME BELONGS HERE'''
 
−
 
 
−
= Road Map and Getting Involved =
 
−
 
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
A project roadmap is the envisioned plan for the project. The purpose of the roadmap is to help others understand where the project is going. It gives the community a chance to understand the context and the vision for the goal of the project. Additionally, if a project becomes inactive, or if the project is abandoned, a roadmap can help ensure a project can be adopted and continued under new leadership.
 
−
</span> 
 
−
 
 
−
<span style="color:#ff0000">
 
−
Roadmaps vary in detail from a broad outline to a fully detailed project charter. Generally speaking, projects with detailed roadmaps have tended to develop into successful projects. Some details that leaders may consider placing in the roadmap include: envisioned milestones, planned feature enhancements, essential conditions, project assumptions, development timelines, etc. You are required to have at least 4 milestones for every year the project is active.
 
−
</span>
 
−
 
 
−
As of October 2013, the priorities are:
 
−
* Finish the referencing for each principle.
 
−
* Update the Project Template.
 
−
* Use the OWASP Press to develop a book.
 
−
* Finish and publish the book on Lulu.
 
−
 
 
−
Involvement in the development and promotion of the OWASP Security Principles Project is actively encouraged!
 
−
You do not have to be a security expert in order to contribute.
 
−
Some of the ways you can help:
 
−
* Helping find references to some of the principles.
 
−
* Project administration support.
 
−
* Wiki editing support.
 
−
* Writing support for the book.
 
−
 
 
−
=Project About=
 
−
 
 
−
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
−
<span style="color:#ff0000">
 
−
This page is where you need to place your legacy project template page if your project was created before October 2013. To edit this page you will need to edit your project information template. You can typically find this page by following this address and substituting your project name where it says "OWASP_Example_Project". When in doubt, ask the OWASP Projects Manager.
 
−
Example template page: https://www.owasp.org/index.php/Projects/OWASP_Example_Project
 
−
</span>
 
−
 
 
−
{{:Projects/OWASP_Example_Project_About_Page}}
 
  
  

Latest revision as of 01:47, 9 February 2017

OWASP Project Header.jpg

The OWASP Security Principles

The project is to discuss SaaS rest API threats, security design and operation best practices for the following key roles.

  1. SaaS API provider: For API builder, the key challenge is to build secure API and ensure the security validation for public API uses
  2. App Builder based on SaaS API: App builder needs to securely implement the authorization/authentication to access the SaaS resource. Handling of access token are the key security topic in App builder.
  3. 3SaaS platform service provider: SaaS platform service provider is to ensure the API platform security such as authorization/authentication management, API interaction between app and end user, abnormal API access monitoring, resource access control and so on.

The SaaS API security is an ecosystem. The security practices require not only SaaS provider but also app builder, and end user involvement. For SaaS API builder, he may follow secure coding guide, OWASP Top 10 to deliver the restAPI. For App builder, he needs to handle the access token securely, verify the certificate of target website, redirect user to authentication (JWT, OpenID connect, SAML) and authorization (Oauth2) through secure transmission HTTPS/TLS. Any missing of the security practices will introduce security risks. Then, the SaaS platform provider constantly monitoring and auditing the usage of services, manage accounts/API, hardening platform. Finally, the end user security awareness to identify phishing app/site will complete the whole security cycle.

Proposed Agenda

  • Key threats
  1. Access Token misuses
  2. Insecure Transmission
  3. 3rd party App insecure implementation
  4. End user Awareness


  • API Provider
  1. Authentication (SSO, JWT, SAML, OpenID connect)
  2. Authorization (Oauth2.0)
  3. Error handling
  4. Input Validation
  5. Security Token


  • App Builder security
  1. Handling of Access Token
  2. Secure Transmission
  3. Target SaaS host CA verification
  4. Storage of sensitive information
  5. Secure rest API implementation
  6. App Security Release Review


  • SaaS platform Operation Security
  1. Password Policy
  2. Auditing and Logging
  3. Access Control
  4. API access rate/traffic Management
  5. Login and Authentication
  6. Session Management
  7. Compliance
  8. Host/Platform Security

Licensing

The OWASP Proactive Controls document is free to use under the Creative Commons ShareAlike 3 License.


What is OWASP Security Principles Project?

The end goal is to identify, cite, and document the fundamental principles of Rest API security in terms of API builder, SaaS platform provider, and API consumer/builder.

This document should be as a guide to security technical architects, API builder and SaaS platform API provider outlining the fundamental principles of security.

Presentation

  • To be updated

Project Leader

Key Contributors

Related Projects

Quick Download

To be updated


News and Events

  • [June 2016] Project Initiated. Call for Contributors.

Classifications

New projects.png Owasp-builders-small.png
Owasp-defenders-small.png
Cc-button-y-sa-small.png
Project Type Files DOC.jpg
Retrieved from "https://wiki.owasp.org/index.php?title=OWASP_SaaS_Rest_API_Secure_Guide&oldid=226180"