यह प्रोजेक्ट Spring Security के साथ OAuth (1a) और OAuth2 का उपयोग करने के लिए सहायता प्रदान करता है। यह मानक Spring और Spring Security प्रोग्रामिंग मॉडल और कॉन्फ़िगरेशन मुहावरों का उपयोग करके इन प्रोटोकॉल के उपभोक्ताओं और प्रदाताओं दोनों को लागू करने की सुविधाएँ प्रदान करता है।

आचार संहिता

यह प्रोजेक्ट Contributor Covenant आचार संहिता का पालन करता है। भाग लेने से, आपसे इस आचार संहिता को बनाए रखने की अपेक्षा की जाती है। कृपया अनुचित व्यवहार की रिपोर्ट [email protected] पर करें।

आरंभ करना

डाउनलोड करें या GIT से क्लोन करें और फिर Maven (3.0.*) और Java (1.6 या बेहतर) का उपयोग करें:

$ git clone ...
$ mvn install -P bootstrap

bootstrap प्रोफ़ाइल का उपयोग केवल पहली बार करें - यह कुछ रिपॉजिटरी को सक्षम करता है जो डिफ़ॉल्ट रूप से poms में प्रकट नहीं किए जा सकते। आपको यह प्रोफ़ाइल अपने स्थानीय settings.xml में जोड़ना उपयोगी लग सकता है।

बिल्ड को काम करने के लिए आपको Redis चलाना होगा। आप इसे homebrew का उपयोग करके इंस्टॉल कर सकते हैं। Redis चलाए बिना बिल्ड में Jedis कनेक्शन अपवादों की भरमार होगी।

SpringSource ToolSuite उपयोगकर्ता (या नवीनतम m2eclipse प्लगइन वाले Eclipse उपयोगकर्ता) प्रोजेक्ट्स को मौजूदा Maven प्रोजेक्ट्स के रूप में आयात कर सकते हैं।

Spring Security OAuth Apache Software License Version 2.0 (license.txt देखें) की शर्तों के तहत जारी किया गया है।

नमूने

नमूने और एकीकरण परीक्षण एक उपनिर्देशिका में हैं। अभिविन्यास और जानकारी के लिए वहाँ एक अलग README है। एक बार जब आपने आर्टिफैक्ट को स्थानीय रूप से स्थापित कर लिया है (जैसा कि ऊपर आरंभ करने के निर्देशों में बताया गया है) तो आपको सक्षम होना चाहिए

$ cd samples/oauth2/tonr
$ mvn tomcat7:run

और ऐप को अपने ब्राउज़र में http://localhost:8080/tonr2/ पर विज़िट करें यह जाँचने के लिए कि यह काम करता है। (यह OAuth 2.0 नमूने के लिए है, OAuth 1.0a नमूने के लिए डायरेक्टरी पथ से "2" हटा दें।) एकीकरण परीक्षणों के लिए Tomcat के लिए थोड़ी अलग सेटिंग्स की आवश्यकता होती है, इसलिए आपको एक प्रोफ़ाइल जोड़नी होगी:

$ cd samples/oauth2/tonr
$ mvn integration-test -P integration

परिवर्तन सूची

प्रति रिलीज़ संबोधित मुद्दों की सूची github में पाई जा सकती है (पुराने रिलीज़ JIRA में हैं)।

अतिरिक्त संसाधन

• Spring Security OAuth उपयोगकर्ता मार्गदर्शिका
• Spring Security OAuth स्रोत
• Stackoverflow

Spring Security OAuth में योगदान

समुदाय में शामिल होने के लिए यहाँ कुछ तरीके दिए गए हैं:

• Spring Community Forums पर Spring समुदाय के साथ जुड़ें। कृपया फ़ोरम पर प्रश्नों का उत्तर देकर और बहस में शामिल होकर सहायता करें।
• बग और नई सुविधाओं के लिए github मुद्दे बनाएँ और उन पर टिप्पणी करें और वोट करें जिनमें आपकी रुचि है।
• Github सामाजिक कोडिंग के लिए है: यदि आप कोड लिखना चाहते हैं, तो हम इस रिपॉजिटरी के फोर्क से पुल अनुरोधों के माध्यम से योगदान को प्रोत्साहित करते हैं। यदि आप इस तरह से कोड का योगदान करना चाहते हैं, तो कृपया उस विशिष्ट मुद्दे को कवर करते हुए एक github मुद्दे का भी संदर्भ दें जिसे आप संबोधित कर रहे हैं।
• सब्सक्राइब करके springframework.org पर आगामी लेखों पर नज़र रखें।

इससे पहले कि हम एक गैर-तुच्छ पैच या पुल अनुरोध स्वीकार करें, हमें आपको योगदानकर्ता समझौते पर हस्ताक्षर करने की आवश्यकता होगी। योगदानकर्ता समझौते पर हस्ताक्षर करने से किसी को मुख्य रिपॉजिटरी में कमिट करने का अधिकार नहीं मिलता है, लेकिन इसका मतलब है कि हम आपके योगदान को स्वीकार कर सकते हैं, और यदि हम ऐसा करते हैं तो आपको एक लेखक का श्रेय मिलेगा। सक्रिय योगदानकर्ताओं को मुख्य टीम में शामिल होने और पुल अनुरोधों को मर्ज करने की क्षमता प्रदान करने के लिए कहा जा सकता है।

कोड सम्मेलन और गृह व्यवस्था

पुल अनुरोध के लिए इनमें से कोई भी आवश्यक नहीं है, लेकिन ये सभी मदद करेंगे। इन्हें मूल पुल अनुरोध के बाद लेकिन मर्ज से पहले भी जोड़ा जा सकता है।

• Spring Framework कोड प्रारूप सम्मेलनों का उपयोग करें। यदि आप Eclipse का उपयोग कर रहे हैं तो प्रोजेक्ट की रूट से eclipse-code-formatter.xml आयात करें। यदि IntelliJ का उपयोग कर रहे हैं, तो spring-intellij-code-style.xml को ~/.IntelliJIdea*/config/codestyles में कॉपी करें और Settings -> Code Styles से spring-intellij-code-style चुनें।
• सुनिश्चित करें कि सभी नई .java फ़ाइलों में कम से कम एक @author टैग के साथ एक सरल Javadoc क्लास टिप्पणी हो जो आपको पहचानती है, और अधिमानतः कम से कम एक पैराग्राफ हो कि क्लास किस लिए है।
• सभी नई .java फ़ाइलों में ASF लाइसेंस हेडर टिप्पणी जोड़ें (प्रोजेक्ट में मौजूदा फ़ाइलों से कॉपी करें)।
• उन .java फ़ाइलों में खुद को @author के रूप में जोड़ें जिन्हें आप पर्याप्त रूप से संशोधित करते हैं (कॉस्मेटिक परिवर्तनों से अधिक)।
• कुछ Javadocs जोड़ें और, यदि आप नेमस्पेस बदलते हैं, तो कुछ XSD दस्तावेज़ तत्व जोड़ें।
• कुछ यूनिट परीक्षण भी बहुत मदद करेंगे - किसी को तो करना ही है।
• यदि कोई और आपकी शाखा का उपयोग नहीं कर रहा है, तो कृपया इसे वर्तमान मास्टर (या मुख्य प्रोजेक्ट में अन्य लक्ष्य शाखा) के विरुद्ध रीबेस करें।