Category:OWASP Enterprise Security API

Home

Don’t write your own security controls! Reinventing the wheel when it comes to developing security controls for every web application or web service leads to wasted time and massive security holes. OWASP Enterprise Security API (ESAPI) Toolkits help software developers guard against security‐related design and implementation flaws. ESAPI is designed to make it easy to retrofit security into existing applications, as well as providing a solid foundation for new development. Allowing for language-specific differences, all OWASP ESAPI versions have the same basic design: There is a set of security control interfaces. They define for example types of parameters that are passed to types of security controls. There is a reference implementation for each security control. The logic is not organization‐specific and the logic is not application‐specific. An example: string‐based input validation. There are optionally your own implementations for each security control. There may be application logic contained in these classes which may be developed by or for your organization. An example: enterprise authentication.

Let's talk here ESAPI Communities Further development of ESAPI occurs through mailing list discussions and occasional workshops, and suggestions for improvement are welcome. For more information, please contact us. esapi-user mailing list (this is the main list) esapi-dev mailing list esapi-php mailing list esapi-python mailing list esapi-summit mailing list	Got developer cycles? ESAPI Coding The ESAPI project is always on the lookout for volunteers who are interested in contributing developer cycles. ESAPI for PHP Developer Onboarding Instructions ESAPI for other languages developer onboarding instructions -- coming soon!	Related resources OWASP Resources OWASP Top Ten OWASP Application Security Verification Standard OWASP Development Guide OWASP Legal Project SQL Injection Prevention Cheat Sheet XSS (Cross Site Scripting) Prevention Cheat Sheet OWASP Press Releases

Did you know...

ESAPI Users

The following organizations are a few of the many organizations that are starting to adopt ESAPI to secure their web applications:

• American Express
• Apache Foundation
• Booz Allen Hamilton
• Aspect Security
• Galois
• Foundstone(McAfee)
• The Hartford
• Infinite Campus
• Lockheed Martin
• MITRE
• Nationwide Insurance
• SANS Institute
• U.S. Navy - SPAWAR
• World Bank

Please let us know how your organization is using OWASP ESAPI. Include your name, organization's name, and brief description of how you are using it. The project lead can be reached here.

Downloads

1. About ESAPI Data sheet(PDF, Word) Project presentation (PowerPoint) Video presentation (YouTube) 2. Get ESAPI ESAPI for Java EE ESAPI for .NET ESAPI for Classic ASP ESAPI for PHP ESAPI for ColdFusion & CFML ESAPI for Python ESAPI for Haskell ESAPI for Javascript	3. Learn ESAPI ESAPI design patterns (not language-specific): (PDF, Word, PPT) The ESAPI Swingset sample application demonstrates how to leverage ESAPI to protect a web application. LAMP should be spelled LAMPE (PDF) ESAPI for Java interface documentation (JavaDocs)

Glossary

ESAPI Terminology

• adapter - There are optionally your own implementations for each security control. There may be application logic contained in these classes which may be developed by or for your organization. The logic may be organization-specific and/or application-specific. There may be proprietary information or logic contained in these classes which may be developed by or for your organization.
• built-in singleton design pattern - The "built-in" singleton design pattern refers to the replacement of security control reference implementations with your own implementations. ESAPI interfaces are otherwise left intact.
• codec - ESAPI encoder/decoder reference implementations.
• core - The ESAPI interfaces and reference implementations that are not intended to be replaced with enterprise-specific versions are called the ESAPI Core.
• exception - ESAPI exception reference implementations.
• extended factory design pattern - The "extended" factory design pattern refers to the addition of a new security control interface and corresponding implementation, which in turn calls ESAPI security control reference implementations and/or security control reference implementations that were replaced with your own implementations. The ESAPI locator class would be called in order to retrieve a singleton instance of your new security control, which in turn would call ESAPI security control reference implementations and/or security control reference implementations that were replaced with your own implementations.
• extended singleton design pattern - The "extended" singleton pattern refers to the replacement of security control reference implementations with your own implementations and the addition/modification/subtraction of corresponding security control interfaces.
• ES-enable (or ESAPI-enable) - Just as web applications and web services can be Public Key Infrastructure (PKI) enabled (PK-enabled) to perform for example certificate-based authentication, applications and services can be OWASP ESAPI-enabled (ES-enabled) to enable applications and services to protect themselves from attackers.
• filter - In ESAPI for Java, there is additionally an HTTP filter that can be called separately from the other controls.
• interfaces - There is a set of security control interfaces. There is no application logic contained in these interfaces. They define for example types of parameters that are passed to types of security controls. There is no proprietary information or logic contained in these interfaces.
• locator - The ESAPI security control interfaces include an "ESAPI" class that is commonly referred to as a "locator" class. The ESAPI locator class is called in order to retrieve singleton instances of individual security controls, which are then called in order to perform security checks (such as performing an access control check) or that result in security effects (such as generating an audit record).
• reference implementation - There is a reference implementation for each security control. There is application logic contained in these classes, i.e. contained in these interface implementations. However, the logic is not organization-specific and the logic is not application-specific. There is no proprietary information or logic contained in these reference implementation classes.
• Web Application Firewall (WAF) - In ESAPI for Java, there is additionally a Web Application Firewall (WAF) that can be called separately from the other controls.

Java EE

PROJECT INFO What does this OWASP project offer you?

RELEASE(S) INFO What does this OWASP project release offer you?

what is this project? OWASP ESAPI for Java EE Purpose: This is the Java EE language version of OWASP ESAPI. The ESAPI for Java EE is the baseline ESAPI design. The current release of this project is suitable for production use The ESAPI 2.x branch supports Java 5 and above, but the latest release (2.2.0.0) requires Java 7 or later. You may view the Javadocs here http://www.javadoc.io/doc/org.owasp.esapi/esapi/ The ESAPI 1.4 branch supports Java 4 and above. Complete information on latest 1.4 branch dependencies can be found here http://owasp-esapi-java.googlecode.com/svn/trunk_doc/1.4.4/site/dependencies.html. (Google may have removed this though, so you may have to search for it on https://archive.org/) The OWASP AppSensor-ESAPI integration guide is out! AppSensor_GettingStarted License: BSD license who is working on this project? Project Leader: Kevin Wall & Matt Seil @ Project Maintainer: ESAPI-Dev mailing list @ Project Contributor(s): Kevin W. Wall @ Matt Seil @ Jeremiah J Stacey Jeff Williams @ Jim Manico @ Chris Schmidt @ See https://github.com/ESAPI/esapi-java-legacy/graphs/contributors for list of other contributors how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: Subscribe or read the archives Project Roadmap: N/A Main links: ESAPI 2.x Downloads All previous ESAPI 1.4.x Downloads (no longer supported) GitHub code repository for ESAPI JAVA Report a bug! Latest ESAPI Javadocs (and earlier versions) ESAPI 1.4.4 Javadocs (may need to access via archive.org as Google was planning to remove Google Code) How to build ESAPI 2.0 with Maven How to build ESAPI 2.0 with Maven via Eclipse Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact Kevin Wall & Matt Seil @ to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

current release 2.2.0.0 - June 25, 2019 - (download) Release Leader: N/A Release details: N/A : Rating: Not Reviewed To be reviewed under Assessment Criteria v2.0

.NET

PROJECT INFO What does this OWASP project offer you?

what is this project? OWASP ESAPI for .NET Purpose: This is the .NET language version of OWASP ESAPI. The current release of this project is not suitable for production use AnkhSVN is a free SVN tool that integrates with Visual Studio. Point your SVN tool at http://owasp-esapi-dotnet.googlecode.com/svn/trunk. Anonymous checkout is supported. You can also browse the source. License: BSD license who is working on this project? Project Leader: None Project Maintainer: Michael Weber @ Project Contributor(s): Paul Apostolescu @ how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: Subscribe or read the archives Project Roadmap: N/A Main links: ESAPI for .NET Google Code repository Download the latest .NET ESAPI library binary from Google Code here. [1] General ESAPI information Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact None to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

Classic ASP

PROJECT INFO What does this OWASP project offer you?

what is this project? OWASP ESAPI for Classic ASP Purpose: This is the Microsoft Classic ASP 3.x language version of OWASP ESAPI. The current release of this project is not suitable for production use License: BSD license who is working on this project? Project Leader: Juan Carlos Calderon @ Project Maintainer: Juan Carlos Calderon @ Project Contributor(s): N/A how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: Subscribe or read the archives Project Roadmap: [[:ESAPI for Classic ASP is currently "mounted" on ESAPI for .NET using interop, however the prevalence of random errors in the technology had make it non usable in real world. Starting on December 2010, the API will be re-written completely to ActiveX objects to avoid any issue related to interop and to other dependencies (.NET Framework) | To view, click here]] Main links: OWASP Classic ASP Security Project Page ESAPI for Classic ASP Google Code Repository ESAPI for Classic ASP readme and release notes General ESAPI information Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact Juan Carlos Calderon @ to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

PHP

PROJECT INFO What does this OWASP project offer you?

what is this project? OWASP ESAPI for PHP Purpose: This is the PHP language version of OWASP ESAPI. The current release of this project is not suitable for production use License: BSD license who is working on this project? Project Leader: Andrew van der Stock @ Project Maintainer: Project Contributor(s): Jah Boite Bipin Upadhyay Arnaud Labenne Martin Reiche Chris White @ how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: Subscribe or read the archives Project Roadmap: N/A Main links: ESAPI for PHP Google Code repository General ESAPI information Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact Andrew van der Stock @ to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

ColdFusion/CFML

PROJECT INFO What does this OWASP project offer you?

what is this project? OWASP ESAPI for ColdFusion/CFML Purpose: This is the ColdFusion/CFML language version of OWASP ESAPI. License: BSD license who is working on this project? Project Leader: Jason Dean @ Project Maintainer: Project Contributor(s): Bill Shelton @ how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: N/A Project Roadmap: N/A Main links: ESAPI for ColdFusion/CFML Google Code repository ESAPI ColdFusion/CFML readme and release notes General ESAPI information Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact Jason Dean @ to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

Python

PROJECT INFO What does this OWASP project offer you?

what is this project? OWASP ESAPI for Python Purpose: This is the Python language version of OWASP ESAPI. The current release of this project is not suitable for production use License: BSD license who is working on this project? Project Leader: Craig Younkins @ Project Maintainer: Project Contributor(s): N/A how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: N/A Project Roadmap: N/A Main links: ESAPI for Python Google Code repository ESAPI Python readme and release notes ESAPI for Python issues may be reported at the Google Code ESAPI issue tracker ESAPI for Python interface documentation General ESAPI information Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact Craig Younkins @ to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

JavaScript

PROJECT INFO What does this OWASP project offer you?

what is this project? OWASP ESAPI for JavaScript Purpose: This is the JavaScript language version of OWASP ESAPI. The current release of this project is not suitable for production use License: BSD license who is working on this project? Project Leader: Chris Schmidt Project Maintainer: Project Contributor(s): N/A how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: N/A Project Roadmap: N/A Main links: ESAPI for JavaScript Google Code repository ESAPI JavaScript readme and release notes General ESAPI information Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact Chris Schmidt to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

---

JavaScript Edition of the OWASP ESAPI Toolkit - Alpha Quality

• The JavaScript version of ESAPI is being lead by Chris Schmidt.
• We are seeking organizations willing to pilot ESAPI and work with us to make this library better. Please contact Chris for more information.
• If you're interested in application security, please join the OWASP ESAPI Developer mailing list and help make ESAPI better!
• If you have questions about using ESAPI, please post to the OWASP ESAPI Users mailing list.

Welcome to the ESAPI JavaScript Edition

This document provides information about the JavaScript Edition of OWASP ESAPI. The topics below cover system requirements, additional product information, and application notes. For information about the new features of this release, known issues, resolved issues, and limitations, refer to the Release notes.

Current Releases

• ESAPI4JS 0.1.2

For all downloads and project files, please click here

• Problems with the ESAPI may be reported here

ESAPI SVN Repository
Checkout ESAPI source from its home on Google code

System Requirements

Any webserver that has approximately 200 kilobytes of available disk space, and properly supports JavaScript, such as Apache or Internet Information Services (IIS).

There are no settings that are required to be set correctly in your properties files to use ESAPI.

Browser Compatibility

• Tested in:
  • Linux
    • Chrome 3.0, Firefox 3.0-3.5
  • Windows
    • Chrome 3.0, Firefox 3.5, Internet Explorer 7.0

If you would like to test in additional browsers, please let me know

Dependencies

• Reference API
  • Log4js

• Unit Tests
  • JSUnit

Roadmap

Coming soon!

Haskell

PROJECT INFO What does this OWASP project offer you?

what is this project? OWASP ESAPI for Haskell Purpose: This is the Haskell language version of OWASP ESAPI. License: BSD license who is working on this project? Project Leader: Sigbjorn Finne @ Project Maintainer: Project Contributor(s): N/A how can you learn more? Project Pamphlet: N/A 3x slide Project Presentation: N/A Mailing list: N/A Project Roadmap: N/A Main links: [http:// ESAPI for Haskell Google Code repository] ESAPI Haskell readme and release notes General ESAPI information Project Health: Not Reviewed (Provisional) To be reviewed under Assessment Criteria v2.0 Key Contacts Contact Sigbjorn Finne @ to contribute, review or sponsor this project Contact the GPC to report a problem or concern about this project or to update information.

---

Haskell Edition of the OWASP ESAPI Toolkit - First release is under development

• The Haskell version of ESAPI is being lead by Sigbjorn Finne. Feel free to contact him at sof 'AT' galois.com for further details.
• Details below will be filled in as work progresses. Volunteers wanted!

---

OWASP ESAPI - Haskell Edition ReadMe

Sigbjorn (and Galois, who is his employer) are contributors to the core Haskell language. The intent of this effort is to make ESAPI for Haskell part of Haskell itself.

Project Details

Please see each language's tab for each version's project details.

Please take a brief moment to take this survey and let the ESAPI Development Team know how we are doing

• Click here to take survey

This project licensed under the BSD license, which is very permissive and about as close to public domain as is possible. You can use or modify ESAPI however you want, even include it in commercial products.