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 "Web Service Security Cheat Sheet"
(→Endpoint Security Profile) |
|||
| Line 1: | Line 1: | ||
= Introduction = | = Introduction = | ||
| − | This article is focused on providing guidance to securing web services and preventing web services related attacks. Please notice that due to the difference of implementation between different frameworks, this cheat sheet is kept at high level. | + | This article is focused on providing guidance to securing web services and preventing web services related attacks. Please notice that due to the difference of implementation between different frameworks, this cheat sheet is kept at a high level. |
== Transport Confidentiality == | == Transport Confidentiality == | ||
| Line 7: | Line 7: | ||
Transport confidentiality protects against eavesdropping and man-in-the-middle attacks against web service communications to\from the server. | Transport confidentiality protects against eavesdropping and man-in-the-middle attacks against web service communications to\from the server. | ||
| − | '''Rule''' - All communication with and between web services containing sensitive features, an authenticated session, or transfer of sensitive data must be encrypted using well configured TLS. For more information see [[Transport Layer Protection Cheat Sheet]] . | + | '''Rule''' - All communication with and between web services containing sensitive features, an authenticated session, or transfer of sensitive data must be encrypted using well configured TLS. This is recommended even if the messages themselves are encrypted because SSL/TLS provides numerous benefits beyond traffic confidentiality including integrity protection, replay defenses, and server authentication. For more information on how to do this properly see the [[Transport Layer Protection Cheat Sheet]]. |
== Server Authentication == | == Server Authentication == | ||
| − | + | '''Rule''' - SSL/TLS must be used to authenticate the service provider to the service consumer. The service consumer should verify the server certificate is issued by a trusted provider, is not expired, is not revoked, matches the domain name of the service, and that the server has proven that it has the private key associated with the public key certificate (by properly signing something or successfully decrypting something encrypted with the associated public key). | |
| − | + | == User Authentication == | |
| − | '''Rule''' - Client Certificate Authentication using | + | User authentication verifies the identity of the user or the system trying to connect to the service. Such authentication is usually a function of the container of the web service. |
| + | |||
| + | '''Rule''' - If used, Basic Authentication must be conducted over SSL, but Basic Authentication is not recommended. | ||
| + | |||
| + | '''Rule''' - Client Certificate Authentication using SSL is a strong form of authentication that is recommended. | ||
== Transport Encoding == | == Transport Encoding == | ||
| Line 29: | Line 33: | ||
== Message Integrity == | == Message Integrity == | ||
| − | + | When using public key cryptography, encryption does guarantee confidentiality but it does not guarantee integrity since the receiver's public key is public. For the same reason, encryption does not ensure the identity of the sender. | |
| − | '''Rule '''- | + | '''Rule '''- For XML data, use XML digital signatures to ensure message integrity using the sender's private key. This signature can be validated by the recipient using the sender’s digital certificate (public key). |
== Message Confidentiality == | == Message Confidentiality == | ||
| Line 37: | Line 41: | ||
Data elements meant to be kept confidential must be encrypted using a strong encryption cipher with an adequate key length to deter brute forcing. | Data elements meant to be kept confidential must be encrypted using a strong encryption cipher with an adequate key length to deter brute forcing. | ||
| − | '''Rule '''- | + | '''Rule''' - Messages containing sensitive data must be encrypted using a strong encryption cipher. This could be transport encryption or message encryption. |
| + | '''Rule''' - Messages containing sensitive data that must remain encrypted at rest after receipt must be encrypted with strong data encryption, not just transport encryption. | ||
== Authorization == | == Authorization == | ||
| − | Web services need to authorize web service clients the same way web applications authorize users. A web service needs to make sure a web service client is authorized to: perform a certain action (coarse-grained); | + | Web services need to authorize web service clients the same way web applications authorize users. A web service needs to make sure a web service client is authorized to: perform a certain action (coarse-grained); on the requested data (fine-grained). |
'''Rule''' - A web service should authorize its clients whether they have access to the method in question. This can be done using one of the following methods: | '''Rule''' - A web service should authorize its clients whether they have access to the method in question. This can be done using one of the following methods: | ||
| Line 50: | Line 55: | ||
== Schema Validation == | == Schema Validation == | ||
| − | Schema validation enforces constraints | + | Schema validation enforces constraints and syntax defined by the schema. |
| − | '''Rule''' - Web services must validate SOAP payloads against the web service | + | '''Rule''' - Web services must validate SOAP payloads against their associated XML schema definition (XSD). |
| + | '''Rule''' - The XSD defined for a SOAP web service should, at a minimum, define the maximum length and character set of every parameter allowed to pass into and out of the web service. | ||
| + | '''Rule''' - The XSD defined for a SOAP web service should define strong (ideally white list) validation patterns for all fixed format parameters (e.g., zip codes, phone numbers, list values, etc.). | ||
== Content Validation == | == Content Validation == | ||
| − | '''Rule''' - Like any web application, web services need to validate input before consuming it. Content validation include: | + | '''Rule''' - Like any web application, web services need to validate input before consuming it. Content validation for XML input should include: |
*Validation against malformed XML entities | *Validation against malformed XML entities | ||
| Line 100: | Line 107: | ||
'''Rule''' - Validation against recursive payloads | '''Rule''' - Validation against recursive payloads | ||
| − | |||
'''Rule''' - Validation against oversized payloads | '''Rule''' - Validation against oversized payloads | ||
| + | '''Rule''' - Protection against XML entity expansion | ||
| − | + | This protections should be provided by your XML parser/schema validator. To verify, build test cases to make sure your parser to resistant to these types of attacks. | |
== Administration == | == Administration == | ||
'''Rule''' - Ensure access to administration and management functions within the Web Service Application is limited to web service administrators. | '''Rule''' - Ensure access to administration and management functions within the Web Service Application is limited to web service administrators. | ||
| + | |||
| + | Ideally, any administrative capabilities would be in an application that is completely separate from the web services being managed by these capabilities, thus completely separating normal users from these sensitive functions. | ||
= Authors and Primary Editors = | = Authors and Primary Editors = | ||
Revision as of 20:56, 7 October 2011
- 1 Introduction
- 1.1 Transport Confidentiality
- 1.2 Server Authentication
- 1.3 User Authentication
- 1.4 Transport Encoding
- 1.5 Consumer Authentication
- 1.6 Message Integrity
- 1.7 Message Confidentiality
- 1.8 Authorization
- 1.9 Schema Validation
- 1.10 Content Validation
- 1.11 Output Encoding
- 1.12 Virus Protection
- 1.13 Message Size
- 1.14 Message Throughput
- 1.15 Endpoint Security Profile
- 1.16 Audit Logging
- 1.17 XML Denial of Service Protection
- 1.18 Administration
- 2 Authors and Primary Editors
Introduction
This article is focused on providing guidance to securing web services and preventing web services related attacks. Please notice that due to the difference of implementation between different frameworks, this cheat sheet is kept at a high level.
Transport Confidentiality
Transport confidentiality protects against eavesdropping and man-in-the-middle attacks against web service communications to\from the server.
Rule - All communication with and between web services containing sensitive features, an authenticated session, or transfer of sensitive data must be encrypted using well configured TLS. This is recommended even if the messages themselves are encrypted because SSL/TLS provides numerous benefits beyond traffic confidentiality including integrity protection, replay defenses, and server authentication. For more information on how to do this properly see the Transport Layer Protection Cheat Sheet.
Server Authentication
Rule - SSL/TLS must be used to authenticate the service provider to the service consumer. The service consumer should verify the server certificate is issued by a trusted provider, is not expired, is not revoked, matches the domain name of the service, and that the server has proven that it has the private key associated with the public key certificate (by properly signing something or successfully decrypting something encrypted with the associated public key).
User Authentication
User authentication verifies the identity of the user or the system trying to connect to the service. Such authentication is usually a function of the container of the web service.
Rule - If used, Basic Authentication must be conducted over SSL, but Basic Authentication is not recommended.
Rule - Client Certificate Authentication using SSL is a strong form of authentication that is recommended.
Transport Encoding
SOAP encoding styles are meant to move data between software objects into XML format and back again.
Rule - Enforce the same encoding style between the client and the server.
Consumer Authentication
Rule - The Message Authentication over SSL mechanism attaches a cryptographically secured identity or authentication token with the message and use SSL for confidentiality protection.
Message Integrity
When using public key cryptography, encryption does guarantee confidentiality but it does not guarantee integrity since the receiver's public key is public. For the same reason, encryption does not ensure the identity of the sender.
Rule - For XML data, use XML digital signatures to ensure message integrity using the sender's private key. This signature can be validated by the recipient using the sender’s digital certificate (public key).
Message Confidentiality
Data elements meant to be kept confidential must be encrypted using a strong encryption cipher with an adequate key length to deter brute forcing.
Rule - Messages containing sensitive data must be encrypted using a strong encryption cipher. This could be transport encryption or message encryption. Rule - Messages containing sensitive data that must remain encrypted at rest after receipt must be encrypted with strong data encryption, not just transport encryption.
Authorization
Web services need to authorize web service clients the same way web applications authorize users. A web service needs to make sure a web service client is authorized to: perform a certain action (coarse-grained); on the requested data (fine-grained).
Rule - A web service should authorize its clients whether they have access to the method in question. This can be done using one of the following methods:
- Having clients authorize to the web service using username and password
- Having clients authorize to the web service using client certificates
Schema Validation
Schema validation enforces constraints and syntax defined by the schema.
Rule - Web services must validate SOAP payloads against their associated XML schema definition (XSD). Rule - The XSD defined for a SOAP web service should, at a minimum, define the maximum length and character set of every parameter allowed to pass into and out of the web service. Rule - The XSD defined for a SOAP web service should define strong (ideally white list) validation patterns for all fixed format parameters (e.g., zip codes, phone numbers, list values, etc.).
Content Validation
Rule - Like any web application, web services need to validate input before consuming it. Content validation for XML input should include:
- Validation against malformed XML entities
- Validation against XML Bomb attacks
- Validating inputs using a strong white list
- Validating against external entity attacks
Output Encoding
Web services need to ensure that output sent to clients is encoded to be consumed as data and not as scripts. This gets pretty important when web service clients use the output to render HTML pages either directly or indirectly using AJAX objects.
Rule - All the rules of output encoding applies as per XSS (Cross Site Scripting) Prevention Cheat Sheet .
Virus Protection
SOAP provides the ability to attach files and document to SOAP messages. This gives the opportunity for hackers to attach viruses and malware to these SOAP messages.
Rule - Ensure Virus Scanning technology is regularly updated with the latest virus definitions / rules.
Message Size
Web services like web applications could be a target for DOS attacks by automatically sending the web services thousands of large size SOAP messages. This either cripples the application making it unable to respond to legitimate messages or it could take it down entirely.
Rule - SOAP Messages size should be limited to an appropriate size limit. Larger size limit (or no limit at all) increases the chances of a successful DoS attack.
Message Throughput
Throughput represents the number of web service requests served during a specific amount of time. Obsviously this depends on many factors including the hardware, the containser of the web service ... etc.
Rule - Configuration should be optimized for maximum message throughput to avoid running into DoS-like situations.
Endpoint Security Profile
Rule - Web services must be compliant with Web Services-Interoperability (WS-I) Basic Profile at minimum.
Audit Logging
Rule - Security related activities such as successful and unsuccessful login attempts must be logged into a protected environment..
XML Denial of Service Protection
XML Denial of Service is probably the most serious attack against web services. So the web service must provide the following validation:
Rule - Validation against recursive payloads Rule - Validation against oversized payloads Rule - Protection against XML entity expansion
This protections should be provided by your XML parser/schema validator. To verify, build test cases to make sure your parser to resistant to these types of attacks.
Administration
Rule - Ensure access to administration and management functions within the Web Service Application is limited to web service administrators.
Ideally, any administrative capabilities would be in an application that is completely separate from the web services being managed by these capabilities, thus completely separating normal users from these sensitive functions.
Authors and Primary Editors
Gunnar Peterson
Sherif Koussa
OWASP Cheat Sheets Project Homepage
