Ce projet fournit un support pour l'utilisation de Spring Security avec OAuth (1a) et OAuth2. Il propose des fonctionnalités pour implémenter à la fois les consommateurs et les fournisseurs de ces protocoles en utilisant les modèles de programmation et les idiomes de configuration standard de Spring et Spring Security.

Code de conduite

Ce projet adhère au code de conduite du Contributor Covenant. En participant, vous vous engagez à respecter ce code. Veuillez signaler tout comportement inacceptable à [email protected].

Pour commencer

Télécharger ou cloner depuis GIT puis utiliser Maven (3.0.*) et Java (1.6 ou plus récent) :

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

Utilisez le profil bootstrap uniquement la première fois - il active certains dépôts qui ne peuvent pas être exposés dans les poms par défaut. Vous pouvez trouver utile d'ajouter ce profil à votre settings.xml local.

Vous devez exécuter Redis pour que la construction fonctionne. Vous pouvez l'installer avec homebrew. Sans Redis en cours d'exécution, la construction générera de nombreuses exceptions de connexion Jedis.

Les utilisateurs de SpringSource ToolSuite (ou les utilisateurs d'Eclipse avec le dernier plugin m2eclipse) peuvent importer les projets en tant que projets Maven existants.

Spring Security OAuth est publié sous les termes de la licence Apache Software License Version 2.0 (voir license.txt).

Exemples

Les exemples et les tests d'intégration se trouvent dans un sous-répertoire. Un README distinct y est fourni pour l'orientation et l'information. Une fois que vous avez installé les artefacts localement (selon les instructions de prise en main ci-dessus), vous devriez pouvoir

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

puis visiter l'application dans votre navigateur à l'adresse http://localhost:8080/tonr2/ pour vérifier qu'elle fonctionne. (Ceci concerne l'exemple OAuth 2.0 ; pour l'exemple OAuth 1.0a, retirez simplement le « 2 » du chemin du répertoire.) Les tests d'intégration nécessitent des paramètres légèrement différents pour Tomcat, vous devez donc ajouter un profil :

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

Journal des modifications

Les listes des problèmes traités par version se trouvent sur github (les versions plus anciennes sont dans JIRA).

Ressources supplémentaires

• Guide de l'utilisateur Spring Security OAuth
• Source de Spring Security OAuth
• Stackoverflow

Contribuer à Spring Security OAuth

Voici quelques façons de vous impliquer dans la communauté :

• Impliquez-vous dans la communauté Spring sur les forums de la communauté Spring. Merci d'aider sur le forum en répondant aux questions et en participant au débat.
• Créez des issues github pour les bugs et les nouvelles fonctionnalités, commentez et votez sur celles qui vous intéressent.
• Github est fait pour le codage social : si vous voulez écrire du code, nous encourageons les contributions par pull requests depuis des forks de ce dépôt. Si vous souhaitez contribuer du code de cette manière, veuillez référencer également une issue github couvrant le problème spécifique que vous traitez.
• Surveillez les prochains articles sur Spring en vous abonnant à springframework.org

Avant d'accepter un correctif ou une pull request non trivial, nous aurons besoin que vous signiez l'accord du contributeur. La signature de l'accord du contributeur ne donne à personne des droits de commit sur le dépôt principal, mais cela signifie que nous pouvons accepter vos contributions, et vous obtiendrez un crédit d'auteur si c'est le cas. Les contributeurs actifs pourraient être invités à rejoindre l'équipe principale et recevoir la possibilité de fusionner les pull requests.

Conventions de code et entretien

Aucune de ces règles n'est essentielle pour une pull request, mais elles aideront toutes. Elles peuvent également être ajoutées après la pull request originale, mais avant une fusion.

• Utilisez les conventions de formatage du code du framework Spring. Importez eclipse-code-formatter.xml depuis la racine du projet si vous utilisez Eclipse. Si vous utilisez IntelliJ, copiez spring-intellij-code-style.xml vers ~/.IntelliJIdea*/config/codestyles et sélectionnez spring-intellij-code-style dans Paramètres -> Styles de code.
• Assurez-vous que tous les nouveaux fichiers .java comportent un simple commentaire de classe Javadoc avec au moins une balise @author vous identifiant, et de préférence au moins un paragraphe sur l'utilité de la classe.
• Ajoutez l'en-tête de licence ASF à tous les nouveaux fichiers .java (copiez depuis les fichiers existants du projet).
• Ajoutez-vous comme @author dans les fichiers .java que vous modifiez de manière substantielle (plus que des modifications cosmétiques).
• Ajoutez quelques Javadocs et, si vous modifiez l'espace de noms, quelques éléments de documentation XSD.
• Quelques tests unitaires aideraient également beaucoup - quelqu'un doit le faire.
• Si personne d'autre n'utilise votre branche, veuillez la rebaser sur le master actuel (ou une autre branche cible du projet principal).