
OWASP Java Encoder एक Java 1.5+ सरल-उपयोग वाला ड्रॉप-इन उच्च-प्रदर्शन एनकोडर क्लास है जिसमें कोई निर्भरता नहीं है और बहुत कम अतिरिक्त भार है। यह प्रोजेक्ट Java वेब डेवलपर्स को क्रॉस साइट स्क्रिप्टिंग से बचाव में मदद करेगा!
Java 8+ के लिए प्रासंगिक आउटपुट एन्कोडिंग। अविश्वसनीय टेक्स्ट प्राप्त करने वाले पार्सर कॉन्टेक्स्ट के लिए एक एन्कोडर चुनें: HTML, JavaScript, CSS, XML या कोई URL घटक। कोर में कोई रनटाइम निर्भरता नहीं है; वैकल्पिक JSP और Jakarta एडाप्टर व्यू-लेयर बाइंडिंग प्रदान करते हैं। एन्कोडिंग [XSS रोकथाम][xss] का एक हिस्सा है, साथ में सुरक्षित टेम्पलेट, URL सत्यापन और अन्य एप्लिकेशन नियंत्रण भी।
1.6.0 Maven Central से उपलब्ध है। यह माइनर रिलीज़ विश्वसनीय फ़्रैगमेंट्स में मान्यता प्राप्त HTML-टोकन सुरक्षा को बनाए रखते हुए अनावश्यक JavaScript अक्षर एस्केपिंग को कम करती है। एन्कोडेड बाइट्स और स्ट्रीमिंग व्यवहार बदलते हैं; देखें रिलीज़ नोट्स और प्रकाशन सत्यापन।
1.5.0 में पेश किए गए पार्सर-सीमा सुरक्षा सुधार प्रभावी बने हुए हैं; 1.4.1 तक के संस्करणों में वे सुधार शामिल नहीं हैं। देखें सुरक्षा सलाह और VERIFYING.md।
अपनी आवश्यकता के अनुसार निर्भरता चुनें।
तीन समर्थित आर्टिफ़ैक्ट्स समूह ID org.owasp.encoder का उपयोग करते हैं:
| Artifact ID | उद्देश्य और रनटाइम निर्भरताएँ |
|---|---|
encoder | कोर String/Writer API; कोई रनटाइम निर्भरता नहीं |
encoder-jsp | लीगेसी javax JSP टैग/EL फ़ंक्शन; कोर और कंटेनर-प्रदत्त JSP API |
encoder-jakarta-jsp | Jakarta JSP टैग/EL फ़ंक्शन; कोर और कंटेनर-प्रदत्त Jakarta JSP API |
<dependency>
<groupId>org.owasp.encoder</groupId>
<artifactId>encoder</artifactId>
<version>1.6.0</version>
</dependency>
जब आवश्यक हो तो encoder को किसी एक टैग एडाप्टर आर्टिफैक्ट ID से बदलें; प्रत्येक एडाप्टर
core को साथ लाता है। अलग से प्रबंधित core/एडाप्टर संस्करणों को संरेखित रखें। javax या Jakarta taglib JARs में से किसी एक का उपयोग करें: वे org.owasp.encoder.tag साझा करते हैं और एक ही classpath या module path पर सह-अस्तित्व में नहीं रह सकते। runtime matrix और
dependency/license inventory देखें।
encoder-esapi को 1.4.1 के बाद सेवानिवृत्त कर दिया गया था और यह 1.5.x या 1.6.0 में शामिल या समर्थित नहीं है। इसका उपयोग करने वाले अनुप्रयोगों को एडाप्टर से दूर माइग्रेट करना होगा।
प्रकाशित 1.6.0 API दस्तावेज़ीकरण (होस्टेड इंडेक्सिंग प्रकाशन से पीछे रह सकती है): core, javax JSP और Jakarta JSP।
import org.owasp.encoder.Encode;
out.write("<p>");
Encode.forHtmlContent(out, userText); // Writer overload; no intermediate String
out.write("</p>");
समतुल्य String कॉल Encode.forHtmlContent(userText) है। कॉलर विश्वसनीय आस-पास का सिंटैक्स और एट्रिब्यूट कोट्स प्रदान करते हैं। कच्चे डेटा को एक बार, आउटपुट सीमा पर एन्कोड करें; अपने टेम्पलेट इंजन द्वारा पहले से किए गए किसी भी एस्केपिंग को ध्यान में रखें।
| गंतव्य | API और सीमाएँ |
|---|---|
| HTML टेक्स्ट, textarea सामग्री सहित | forHtmlContent; forHtml उद्धृत सामान्य टेक्स्ट एट्रिब्यूट्स को भी कवर करता है |
| उद्धृत HTML टेक्स्ट एट्रिब्यूट | forHtmlAttribute; इवेंट-हैंडलर एक्सप्रेशन या URL वैलिडेटर नहीं |
| एक कच्चा URL घटक | forUriComponent; विश्वसनीय डेलिमीटर के साथ जोड़ें, URL को मान्य करें, फिर संलग्न HTML एट्रिब्यूट के लिए एन्कोड करें |
| JavaScript स्ट्रिंग | forJavaScript; सिंगल/डबल कोट्स प्रदान करें। सामान्य अनटैग्ड टेम्पलेट लिटरल टेक्स्ट के लिए 1.5 आवश्यक है। टैग्ड टेम्पलेट्स, एक्सप्रेशन बॉडी, JSON या स्क्रिप्ट URL में कभी उपयोग न करें |
| JSON स्ट्रिंग सामग्री | forJson (1.5); डबल कोट्स प्रदान करें। पूर्ण दस्तावेज़ के लिए सीरियलाइज़र को प्राथमिकता दें |
उद्धृत CSS स्ट्रिंग / CSS url(...) मान | forCssString / forCssUrl; URL को मान्य करें और विधि के आस-पास के संदर्भ नियमों का पालन करें |
| XML 1.0 टेक्स्ट / उद्धृत एट्रिब्यूट | forXmlContent / forXmlAttribute; forXml दोनों को कवर करता है |
| XML 1.1 टेक्स्ट / उद्धृत एट्रिब्यूट | forXml11Content / forXml11Attribute (कोर 1.4+); इसके लिए XML 1.1 दस्तावेज़/पार्सर आवश्यक है, HTML नहीं |
| XML CDATA / टिप्पणी | forCDATA / forXmlComment; HTML टिप्पणियाँ नहीं |
| Java स्रोत स्ट्रिंग लिटरल | forJava; कॉलर कोट्स प्रदान करता है; अयुग्मित सरोगेट्स संकलित नहीं हो सकते |
सूचीबद्ध प्रत्येक फ़साड विधि में String और Writer ओवरलोड हैं। संदर्भ गाइड नेस्टिंग, null/Unicode व्यवहार, JavaScript वेरिएंट, टेम्पलेट सीमाएँ, JSON और असुरक्षित संदर्भों की व्याख्या करता है। Java/JSP उदाहरण पूर्ण आस-पास का सिंटैक्स दिखाते हैं।
एन्कोडिंग HTML को सैनिटाइज़ नहीं करती, इनपुट/URL को मान्य नहीं करती, JSON दस्तावेज़ों को सीरियलाइज़ नहीं करती, SQL पैरामीटरीकरण नहीं करती, या डेटा को डिकोड/कैनोनिकलाइज़ नहीं करती। जब मार्कअप की अनुमति होनी चाहिए तो HTML सैनिटाइज़र का उपयोग करें; SQL के लिए पैरामीटरीकृत क्वेरी का उपयोग करें। इन विशिष्ट भूमिकाओं के लिए [OWASP Java security-library guide][java-libraries] देखें।
Taglib URI पहचानकर्ता हैं, ऐसे URL नहीं जिन्हें ब्राउज़र में खुलना चाहिए:
| अडैप्टर | बेसिक पहचानकर्ता | एडवांस्ड पहचानकर्ता |
|---|---|---|
| Jakarta | owasp.encoder.jakarta | owasp.encoder.jakarta.advanced |
| javax JSP | https://www.owasp.org/index.php/OWASP_Java_Encoder_Project | वही पहचानकर्ता जिसके अंत में #advanced जोड़ा गया है |
<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" isELIgnored="false" %>
<%@ taglib prefix="e" uri="owasp.encoder.jakarta" %>
<p>${e:forHtmlContent(param.message)}</p>
javax कंटेनर के लिए javax पहचानकर्ता का उपयोग करें। टैग खाली बॉडी और एक आवश्यक value विशेषता का उपयोग करते हैं, उदाहरण के लिए <e:forHtmlContent value="${param.message}" />। बुनियादी बनाम उन्नत विधियों और संस्करण-संवेदनशील परिनियोजन सेटिंग्स के लिए bindings and EL evaluation देखें। 1.5 में, उन्नत taglibs forJava को छोड़कर प्रत्येक Encode.forX(String) संदर्भ को उजागर करते हैं; Java स्रोत जनरेशन एक JSP संदर्भ नहीं है। XML 1.1 बाइंडिंग्स 1.5 में नए हैं।
जारी API में Encode.forUri को अप्रचलित (deprecated) किया गया है। संस्करण 1.5.0 उस अप्रचलन को Encoders.URI, दोनों ForUriTag क्लासेस और forUri टैग/फ़ंक्शन दस्तावेज़ीकरण तक विस्तारित करता है। ये सभी प्रवेश बिंदु 1.x के माध्यम से बनाए रखे गए हैं। पूरे URI को एन्कोड करना उसे मान्य नहीं करता: forUri("javascript:alert(1)") इसे अपरिवर्तित लौटाता है। मौजूदा % चिह्न फिर से एन्कोड किए जाते हैं। एक कच्चे पैरामीटर नाम/मान, पथ खंड या फ़्रैगमेंट के लिए forUriComponent का उपयोग करें; पूर्ण URL को अलग से मान्य करें, फिर जब किसी को उद्धृत HTML विशेषता में रखें तो forHtmlAttribute का उपयोग करें। केवल java.net.URI के साथ पार्स करना सुरक्षा स्थापित नहीं करता। worked URL example देखें।
अप्रचलित core/tag API को हटाने के लिए अलग से समीक्षित भविष्य-प्रमुख निर्णय की आवश्यकता है; अप्रचलन हटाने की समय-सारणी नहीं है। अलग ऐतिहासिक ESAPI एडाप्टर को 1.5.0 में ले जाने के बजाय सेवानिवृत्त कर दिया गया है।
हमारे समुदाय द्वारा सबसे अधिक उपयोग किए जाने वाले उपकरण खोजें।
अभी तक कोई लोकप्रियता डेटा नहीं है।