Groupe 1B (SSO et gestion des autorisations)
Date de création :	octobre 2003
Dernière modification :	12 octobre 2004
Diffusion :	internet

Librairie CAS Pour uPortal

Téléchargment :

Ce module est maintenant inclus dans les distribution esup (en CVS module Utils)

But :

Cette librairie a pour but de faciliter l'utilisation de cas dans uPortal. Elle sera surtout utilisée par les canaux afin de dialoguer avec le serveur CAS.

Principe de fonctionnement :

La librarie CAS est constituée d'une classe implémentant des méthodes statiques et des classes d'exceptions.

Installation :

Adapter le build.properties (deploy.home et servlet.jar)

puis faire ant et enfin ant deploy

Méthode disponible :

Recupération d'un Proxy Ticket (PT) :

Rappel :

uPortal est un proxy CAS. Lors de l'authentification CAS (pour uPortal), on obtient un Proxy Granting Ticket (PGT). Ce PGT est utile pour un fonctionnement n-tiers. Il sert a obtenir un Proxy Ticket (PT) qui servira au service tiers pour authentifier l'utilisateur auprès de CAS.

Méthode :

La méthode get_pt permet de récupérer un PT CAS.

Elle peut être appelée de deux mannières différentes :

get_pt(ChannelStaticData sd, String targetService)
get_pt(ChannelStaticData sd, String targetService,int retry, int sleep)

Avec :

sd : les données statiques fournies par le portail (voir méthode setStaticData d'un canal)
targetService : le service de destination du PT (imap://mail.univ-nancy2.fr, http://www.univ-nancy2.fr/test_service.php, ...)
retry : le nombre de tentative d'appel à CAS dans le cas d'erreur de communication (3 par défaut)
sleep : le temps (en secondes) entre chaque appel à CAS en cas d'erreur de communication (1 secondes par défaut)

Principe de fonctionnement :

Cette méthode recupère un PT CAS. Pour ce faire elle doit :

récupérer le contexte de sécurité CAS (YaleCasContext)
vérifier que la personne a bien été authentifiée par CAS
requiert un PT auprès du serveur CAS pour un service tiers donné.
traiter les erreurs éventuelles

Exceptions rapportées:

Plusieurs type d'exception peut être déclenchées lors de la récupération d'un PT.
Ces exceptions héritent de CASGenericException et sont découpées de la sorte :

CASPermException : Exception à caractère permanent
CASTempException : Exception à caractère temporaire

Chaque exception peut renvoyer plusieurs codes erreurs afin de faciliter son traitement (ces codes sont des constantes de CASGenericException) :

CASPermException
- CASGenericException.NO_SERVICE_CALL : Afin de récuperer un PT il faut un service. Celui-ci n'est pas spécifié (null) lors de l'appel à la méthode get_pt.
- CASGenericException.NO_CAS_SECURITY_CONTEXT : Aucun contexte de sécurité ne correspond à CAS. Erreur de configuration de uPortal (pas de CAS dans security.properties)
- CASGenericException.NO_CAS_AUTH : La personne n'est pas authentifié avec CAS.
- CASGenericException.CAS_INTERNAL_ERROR : Une erreur interne du serveur CAS a eu lieu.
- CASGenericException.CAS_INVALID_REQUEST : Il manque des paramêtres pour obtenir un PT.
- CASGenericException.CAS_NOT_VALID_PT : Le PT reçu n'est pas valide (commence pas par PT-).
CASTempException : Exception à caractère temporaire
- CASGenericException.CAS_IO_ERROR : Une erreur de communication avec le serveur CAS a eu lieu.
- CASGenericException.CAS_BAD_PGT : Le PGT utilisé pour obtenir un PT n'est pas valide.

Exemple d'utilisation :

import org.esupportail.portal.utils.*;
import org.esupportail.portal.utils.CASExceptions.*;
...
...
try{
   PT=getMyPT();
}
catch(CASTempException exp){
   Exception="TEMPORAIRE : CASTempException";
   CodeException=exp.getExceptionCode();
   MsgException=exp.getMessage();
   LogService.log(LogService.ERROR, "CGetPT::getMyPT() : Exception de type    temporaire (Temp): "+exp.getExceptionCode()+" "+exp.getMessage());

   if(CodeException==CASGenericException.CODE_CAS_BAD_PGT){
      LogService.log(LogService.DEBUG, "ERREUR Il faudrait aller rechercher un PGT.");
	  // remonte l'exception à uPortal qui l'affiche dans le canal CError
	  throw new PortalException("ERREUR remontée à l'uilisateur : Ceci est une ERREUR gérer dans uPortal, Il faudrait aller rechercher un PGT");
   }
}
catch(CASPermException exp){
   Exception="PERMANENTE : CASPermException";
   CodeException=exp.getExceptionCode();
   MsgException=exp.getMessage();
   LogService.log(LogService.ERROR, "CGetPT::getMyPT() : Exception de type    permanent (Perm): "+exp.getExceptionCode()+" "+exp.getMessage());
}
catch(CASGenericException exp){
   Exception="GENERIC : CASGenericException";
   CodeException=exp.getExceptionCode();
   MsgException=exp.getMessage();
   LogService.log(LogService.ERROR, "CGetPT::getMyPT() : Exception de type    générique (Generic): "+exp.getExceptionCode()+" "+exp.getMessage());
}

A venir :

Rafraichissement de PGT : le but est d'avoir une procédure qui permet d'aller rechercher un PGT. Ceci implique un redirection du navigateur utilisateur (pas si simple dans uPortal)

Création : octobre 2003 - Julien Marchal (Université de Nancy 2)
Modifications : 02/12/2003 : adaptation des noms de package (JM) 12/10/2004 : inclusion dans esup (JM)