يوفر هذا المشروع دعمًا لاستخدام 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 في المرة الأولى فقط - فهو يفعّل بعض المستودعات التي لا يمكن كشفها في ملفات pom افتراضيًا. قد تجد أنه من المفيد إضافة ملف التعريف هذا إلى settings.xml المحلي لديك.

تحتاج إلى تشغيل Redis لكي يعمل البناء. يمكنك تثبيته باستخدام homebrew. بدون تشغيل Redis، سيواجه البناء الكثير من استثناءات اتصال Jedis.

يمكن لمستخدمي SpringSource ToolSuite (أو مستخدمي Eclipse الذين يستخدمون أحدث إصدار من مكون m2eclipse الإضافي) استيراد المشاريع كمشاريع Maven موجودة.

تم إصدار Spring Security OAuth بموجب شروط رخصة Apache Software License الإصدار 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 في منتديات Spring Community. يرجى المساعدة في المنتدى من خلال الرد على الأسئلة والانضمام إلى النقاش.
• أنشئ مشكلات على github للأخطاء والميزات الجديدة وعلّق وصوّت على تلك التي تهتم بها.
• Github مخصص للبرمجة الاجتماعية: إذا كنت تريد كتابة كود، فإننا نشجع على المساهمات عبر طلبات السحب من نسخ هذا المستودع. إذا كنت تريد المساهمة بكود بهذه الطريقة، فيرجى الإشارة إلى مشكلة على github تغطي المشكلة المحددة التي تعالجها.
• تابع المقالات القادمة حول Spring عن طريق الاشتراك في springframework.org

قبل قبول أي تصحيح أو طلب سحب غير بسيط، سنحتاج منك التوقيع على اتفاقية المساهم. توقيع اتفاقية المساهم لا يمنح أي شخص حقوق الالتزام (commit) في المستودع الرئيسي، ولكنه يعني أنه يمكننا قبول مساهماتك، وستحصل على ائتمان كمؤلف إذا قبلناها. قد يُطلب من المساهمين النشطين الانضمام إلى الفريق الأساسي، ومنحهم القدرة على دمج طلبات السحب.

اصطلاحات الكود والتنظيم الداخلي

لا شيء من هذه الأمور ضروري لطلب السحب، لكنها جميعًا ستفيد. يمكن أيضًا إضافتها بعد طلب السحب الأصلي ولكن قبل الدمج.

• استخدم اصطلاحات تنسيق الكود الخاصة بـ Spring Framework. استورد eclipse-code-formatter.xml من جذر المشروع إذا كنت تستخدم Eclipse. إذا كنت تستخدم IntelliJ، انسخ spring-intellij-code-style.xml إلى ~/.IntelliJIdea*/config/codestyles واختر spring-intellij-code-style من Settings -> Code Styles.
• تأكد من أن جميع ملفات .java الجديدة تحتوي على تعليق Javadoc بسيط للفئة مع وسم @author واحد على الأقل يعرّف بك، ويفضل أن يتضمن فقرة واحدة على الأقل حول الغرض من الفئة.
• أضف تعليق رأس الترخيص ASF إلى جميع ملفات .java الجديدة (انسخه من الملفات الموجودة في المشروع)
• أضف نفسك كـ @author إلى ملفات .java التي تعدّلها بشكل جوهري (أكثر من تغييرات تجميلية).
• أضف بعض Javadocs، وإذا غيّرت مساحة الاسم (namespace)، أضف بعض عناصر توثيق XSD.
• بعض اختبارات الوحدة ستساعد كثيرًا أيضًا - شخص ما يجب أن يقوم بها.
• إذا لم يكن أي شخص آخر يستخدم فرعك (branch)، فيرجى إعادة تأسيسه (rebase) على master الحالي (أو فرع هدف آخر في المشروع الرئيسي).