diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..df911ae --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__MACOSX/ +.idea/ \ No newline at end of file diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000..7103dd3 --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,4 @@ + +Copyright (C) 2002-2003, EPFL, Lausanne, Switzerland. + +http://www.epfl.ch/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5b6e7c6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/doc/Tequila-Dev_Guide.docx b/doc/Tequila-Dev_Guide.docx new file mode 100644 index 0000000..e997627 Binary files /dev/null and b/doc/Tequila-Dev_Guide.docx differ diff --git a/doc/Tequila-User_Guide.docx b/doc/Tequila-User_Guide.docx new file mode 100644 index 0000000..fb1ceab Binary files /dev/null and b/doc/Tequila-User_Guide.docx differ diff --git a/src/tequila.php b/src/tequila.php new file mode 100644 index 0000000..c8bfe8e --- /dev/null +++ b/src/tequila.php @@ -0,0 +1,961 @@ + 'english', + LNG_FRENCH => 'francais', + ); + var $aErrors = array( + ERROR_UNKNOWN_ERROR => array( + LNG_ENGLISH => 'An unknown error has occured.', + LNG_FRENCH => 'Une erreur inconnue est survenue.', + ), + ERROR_SESSION_DIR_NOT_WRITEABLE => array( + LNG_ENGLISH => 'Error: the given sessions directory is not writeable.', + LNG_FRENCH => 'Erreur: le répertoire de sessions indiqué ne peut pas être écrit.', + ), + ERROR_SESSION_FILE_FORMAT => array( + LNG_ENGLISH => 'Error: invalid session file format.', + LNG_FRENCH => 'Erreur: format de fichier de session non valide.', + ), + ERROR_CREATE_SESSION_FILE => array( + LNG_ENGLISH => 'Error: session file creation failed.', + LNG_FRENCH => 'Erreur: échec lors de la création du fichier de session.', + ), + ERROR_NO_DATA => array( + LNG_ENGLISH => 'Error: no session data.', + LNG_FRENCH => 'Erreur: aucune donnée de session.', + ), + ERROR_NO_SESSION_DIR => array( + LNG_ENGLISH => 'Error: inexistant or unspecified sessions directory.', + LNG_FRENCH => 'Erreur: dossier de sessions inexistant ou non spécifié.', + ), + ERROR_NO_SERVER_DEFINED => array( + LNG_ENGLISH => 'Error: no authentication server available.', + LNG_FRENCH => 'Erreur: aucun serveur d\'authentification disponible.', + ), + ERROR_UNSUPPORTED_METHOD => array( + LNG_ENGLISH => 'Error: unsupported request method.', + LNG_FRENCH => 'Erreur: méthode de transmission inconnue.', + ), + ERROR_NOT_READABLE => array( + LNG_ENGLISH => 'Error: unable to read session file.', + LNG_FRENCH => 'Erreur: fichier de session non lisible.', + ), + ERROR_CREATE_FILE => array( + LNG_ENGLISH => 'Error: unable to create session file.', + LNG_FRENCH => 'Erreur: impossible de créer le fichier de sessions.', + ), + ERROR_SESSION_TIMEOUT => array( + LNG_ENGLISH => 'Error: session timed out.', + LNG_FRENCH => 'Erreur: la session a expiré.', + ), + ERROR_CREATE_SESSION_DIR => array( + LNG_ENGLISH => 'Error: unable to create sessions directory.', + LNG_FRENCH => 'Erreur: impossible de créer le dossier de sessions défini.', + ), + ERROR_NO_MESSAGE => array( + LNG_ENGLISH => 'Error: no message to authenticate.', + LNG_FRENCH => 'Erreur: pas de message à vérifier.', + ), + ERROR_NO_SERVER_KEY => array( + LNG_ENGLISH => 'Error: no public key defined.', + LNG_FRENCH => 'Erreur: la clé publique du serveur d\'authentification n\'est pas définie ou disponible.', + ), + ERROR_NO_VALID_PUBLIC_KEY => array( + LNG_ENGLISH => 'Error: invalid public key.', + LNG_FRENCH => 'Erreur: la clé publique fournie n\'est pas valide.', + ), + ERROR_NO_SIGNATURE => array( + LNG_ENGLISH => 'Error: no signature for mesage authentication.', + LNG_FRENCH => 'Erreur: pas de signature pour la vérification du mesage.', + ), + ERROR_NO_KEY => array ( + LNG_ENGLISH => 'Error: no session key.', + LNG_FRENCH => 'Erreur: pas de clé de session.', + ), + ERROR_SESSION_FILE_EXISTS => array ( + LNG_ENGLISH => 'Error: session already created.', + LNG_FRENCH => 'Erreur: session déjà créée.', + ), + ERROR_CURL_NOT_LOADED => array ( + LNG_ENGLISH => 'Error: CURL Extension is not loaded.', + LNG_FRENCH => 'Erreur: L\'extension CURL n\'est pas présente.', + ), + ); + var $aWantedRights = array (); + var $aWantedRoles = array (); + var $aWantedAttributes = array (); + var $aWishedAttributes = array (); + var $aWantedGroups = array (); + var $aCustomAttrs = array (); + var $sCustomFilter = ''; + var $sAllowsFilter = ''; + var $iLanguage = LNG_FRENCH; + var $sApplicationURL = ''; + var $sApplicationName = ''; + var $sResource = ''; + var $sKey = ''; + var $sMessage = ''; + var $aAttributes = array(); + var $iTimeout; + var $sServer = ''; + var $sServerUrl = ''; + var $sCAFile = ''; + var $sCertFile = ''; + var $sKeyFile = ''; + var $bReportErrors = TRUE; + var $stderr; + + var $logoutUrl; + + var $requestInfos = array(); + + /*====================== Constructor + GOAL : Class constructor + NOTE : All parameters are optional. They are present in the config + file tequila_config.inc.php + IN : $sServerURL -> (optional) Tequila server address (ie : https://tequila.epfl.ch/cgi-bin/tequila) + IN : $sSessionsDirectory -> (optional) The directory where to save sessions files + IN : $iTimeout -> (optional) Session timeout + */ + function TequilaClient ($sServer = '', $iTimeout = NULL) { + $this->stderr = fopen ('php://stderr', 'w'); + + /* If curl is not found, */ + if (!extension_loaded ('curl')) { + return $this->Error (ERROR_CURL_NOT_LOADED); + } + + /* Initializations. If no parameter given, get info from config file */ + if (empty ($sServer)) $sServer = GetConfigOption ('sServer'); + if (empty ($sServer)) $sServerUrl = GetConfigOption ('sServerUrl'); + + $aEtcConfig = $this->LoadEtcConfig (); + + if (empty ($sServer)) $sServer = $aEtcConfig ['sServer']; + if (empty ($sServerUrl)) $sServerUrl = $aEtcConfig ['sServerUrl']; + + if (empty ($sServerUrl) && !empty ($sServer)) + $sServerUrl = $sServer . '/cgi-bin/tequila'; + if (empty ($iTimeout)) $iTimeout = GetConfigOption ('iTimeout', 86400); + if (empty ($logoutUrl)) $logoutUrl = GetConfigOption ('logoutUrl'); + + $this->sServer = $sServer; + $this->sServerUrl = $sServerUrl; + $this->iTimeout = $iTimeout; + $this->logoutUrl = $logoutUrl; + $this->iCookieLife = COOKIE_LIFE; + $this->sCookieName = COOKIE_NAME; + } + + /*====================== ERROR MANAGEMENT + GOAL : Manage errors + IN : $iError -> the number representing the error + */ + function Error ($iError) { + + /* If not debug mode */ + if (!$this->bReportErrors) return ($iError); + + /* If language not initilized*/ + $iCurrentLanguage = $this->GetLanguage (); + if (empty ($iCurrentLanguage)) + $iCurrentLanguage = LNG_FRENCH; + + /* If the error number is found in the errors array, */ + if (array_key_exists ($iError, $this->aErrors)) + /* Error display */ + echo "\n
" . + $this->aErrors[$iError][$iCurrentLanguage] . + "
\n"; + else /* Error not found */ + echo "\n
" . + $this->aErrors [ERROR_UNKNOWN_ERROR][$iCurrentLanguage] . + "
\n"; + return ($iError); + } + + /*====================== + GOAL : Set if you want display the errors or not + IN : $bReportErrors -> (TRUE|FALSE) + */ + function SetReportErrors ($bReportErrors) { + $this->bReportErrors = $bReportErrors; + } + + /* GOAL : Return the value of bReportErrors (TRUE|FALSE) */ + function GetReportErrors () { + return ($this->bReportErrors); + } + + function LoadEtcConfig () { + $sFile = '/etc/tequila.conf'; + if (!file_exists ($sFile)) return false; + if (!is_readable ($sFile)) return false; + + $aConfig = array (); + $sConfig = trim (file_get_contents ($sFile)); + $aLine = explode ("\n", $sConfig); + foreach ($aLine as $sLine) { + if (preg_match ('/^TequilaServer:\s*(.*)$/i', $sLine, $match)) + $aConfig ['sServer'] = $match [1]; + + if (preg_match ('/^TequilaServerUrl:\s*(.*)$/i', $sLine, $match)) + $aConfig ['sServerUrl'] = $match [1]; + } + return $aConfig; + } + + /*====================== Custom parameters + GOAL : Set the custom parameters + IN : $customParameters -> an array containing the parameters. The + array key is the name of the parameter and the value is the value. + */ + function SetCustomParamaters ($customParamaters) { + foreach ($customParamaters as $key => $val) { + $this->requestInfos [$key] = $val; + } + } + + /* GOAL : Returns the custom parameters */ + function GetCustomParamaters () { + return $this->requestInfos; + } + + /*********************** WANTED RIGHTS *************************** + ====================== Required rights ("wantright" parameter) + GOAL : set the wanted rights + IN : $aWantedRights -> an array with the rights + */ + function SetWantedRights ($aWantedRights) { + $this->aWantedRights = $aWantedRights; + } + + /* + GOAL : Add a wanted right. The wanted right must be an array. It + will be merged we the array containing the wanted rights. + IN : $aRightsToAdd -> an array containing the wanted rights to add + */ + function AddWantedRights ($aWantedRights) { + $this->aWantedRights = array_merge ($this->aWantedRights, $aWantedRights); + } + + /* + GOAL : Remove some wanted rights + IN : $aRightsToRemove -> an array with the wanted rights to remove + */ + function RemoveWantedRights ($aWantedRights) { + foreach ($this->aWantedRights as $sWantedRight) + if (in_array($sWantedRight, $aWantedRights)) + unset($this->aWantedRights[array_search($sWantedRight, $this->aWantedRights)]); + } + + /* GOAL : Returns the wanted rights array. */ + function GetWantedRights () { + return ($this->aWantedRights); + } + + /************************ WANTED ROLES *************************** + ====================== Required roles ("wantrole" parameter) + GOAL : Set the wanted Roles + IN : $aWantedRoles -> an array with the wanted roles + */ + function SetWantedRoles ($aWantedRoles) { + $this->aWantedRoles = $aWantedRoles; + } + + /* + GOAL : Add some wanted roles to the current roles + IN : $aRolesToAdd -> an array with the roles to add. + */ + function AddWantedRoles ($aWantedRoles) { + $this->aWantedRoles = array_merge ($this->aWantedRoles, $aWantedRoles); + } + + /* + GOAL : Remove some wanted roles from the list + IN : $aRolesToRemove -> an array with the roles to remove + */ + function RemoveWantedRoles ($aWantedRoles) { + foreach ($this->aWantedRoles as $sWantedRole) + if (in_array ($sWantedRole, $aWantedRoles)) + unset ($this->aWantedRoles [array_search ($sWantedRole, $this->aWantedRoles)]); + } + + /* GOAL : Returns the array containing the wanted roles */ + function GetWantedRoles () { + return ($this->aWantedRoles); + } + + /********************* REQUIRED ATTRIBUTES *********************** + ====================== Required attributes ("request" parameter) + GOAL : Set the wanted attributes + IN : $aWantedAttributes -> an array containing the wanted attributes + */ + function SetWantedAttributes ($aWantedAttributes) { + $this->aWantedAttributes = $aWantedAttributes; + } + + /* + GOAL : Add some wanted attributes to the list + IN : $aAttributesToAdd -> an array with the attributes to add + */ + function AddWantedAttributes ($aWantedAttributes) { + $this->aWantedAttributes = array_merge ($this->aWantedAttributes, + $aWantedAttributes); + } + + /* + GOAL : Remove some wanted attributes from the list + IN : $aAttributesToRemove -> an array containing the attributes to remove + */ + function RemoveWantedAttributes ($aWantedAttributes) { + foreach ($this->aWantedAttributes as $sWantedAttribute) + if (in_array($sWantedAttribute, $aWantedAttributes)) + unset ($this->aWantedAttributes [array_search($sWantedAttribute, + $this->aWantedAttributes)]); + } + + /* GOAL : Returns the array containing the wanted attributes */ + function GetWantedAttributes () { + return ($this->aWantedAttributes); + } + + /********************** WISHED ATTRIBUTES ************************ + ====================== Desired attributes ("wish" parameter) + GOAL : Set the wished attributes + IN : $aWishedAttributes -> an array containing the wished attributes + */ + function SetWishedAttributes ($aWishedAttributes) { + $this->aWishedAttributes = $aWishedAttributes; + } + + /* + GOAL : Add some wished attributes to the list + IN : $aAttributesToAdd -> an array containing the attributes to add + */ + function AddWishedAttributes ($aWishedAttributes) { + $this->aWishedAttributes = array_merge ($this->aWishedAttributes, + $aWishedAttributes); + } + + /* + GOAL : Remove some wished attributes fromme the list + IN : $aAttributesToRemove -> an array with the attributes to remove + */ + function RemoveWishedAttributes ($aWishedAttributes) { + foreach ($this->aWishedAttributes as $aWishedAttribute) + if (in_array($aWishedAttribute, $aWishedAttributes)) + unset ($this->aWishedAttributes[array_search($aWishedAttribute, + $this->aWishedAttributes)]); + } + + /* GOAL : Returns the array containing the wished attributes */ + function GetWishedAttributes () { + return ($this->aWishedAttributes); + } + + /************************ WANTED GROUPS ************************** + ====================== Required groups ("belongs" parameter) + GOAL : Set the wanted groups + IN : $aWantedGroups -> an array containing the groups + */ + function SetWantedGroups ($aWantedGroups) { + $this->aWantedGroups = $aWantedGroups; + } + + /* + GOAL : Add some wanted groups to the list + IN : $aGroupsToAdd -> an array containing the groups to add + */ + function AddWantedGroups ($aWantedGroups) { + $this->aWantedGroups = array_merge($this->aWantedGroups, $aWantedGroups); + } + + /* + GOAL : Remove some wanted groups from the list + IN : $aGroupsToRemove -> an array containing the groups to remove + */ + function RemoveWantedGroups ($aWantedGroups) { + foreach ($this->aWantedGroups as $aWantedGroup) + if (in_array($aWantedGroup, $aWantedGroups)) + unset($this->aWantedGroups[array_search($aWantedGroup, + $this->aWantedGroups)]); + } + + /* GOAL : Returns the array containing the wanted groups */ + function GetWantedGroups () { + return ($this->aWantedGroups); + } + + /************************* CUSTOM FILTER ************************** + ====================== Own filter ("require" parameter) + GOAL : Set the custom filter. + IN : $sCustomFilter -> a string containing the custom filter + */ + function SetCustomFilter ($sCustomFilter) { + $this->sCustomFilter = $sCustomFilter; + } + + /* GOAL : Returns the string containing the custom filter */ + function GetCustomFilter () { + return ($this->sCustomFilter); + } + + /************************ ALLOWS FILTER ************************** + ====================== Allows filter ("allows" parameter) + GOAL : Sets the allow filter + IN : $sAllowsFilter -> a string containing the allow filter + */ + function SetAllowsFilter ($sAllowsFilter) { + $this->sAllowsFilter = $sAllowsFilter; + } + + /* GOAL : Returns the string containing the allows filter */ + function GetAllowsFilter () { + return ($this->sAllowsFilter); + } + + /********************* LANGUAGE INTERFACE ************************* + ====================== Interface language ("language" parameter) + GOAL : Sets the current language + IN : $sLanguage -> the language : 'english' | 'francais' + */ + function SetLanguage ($sLanguage) { + $this->iLanguage = $sLanguage; + } + + /* GOAL : Returns the current language */ + function GetLanguage () { + return ($this->iLanguage); + } + + /*********************** APPLICATION URL ************************** + ====================== Application URL ("urlaccess" parameter) + GOAL : Sets the application URL. This is the URL where to redirect + when the authentication has been done + IN : $sApplicationURL -> the url + */ + function SetApplicationURL ($sApplicationURL) { + $this->sApplicationURL = $sApplicationURL; + } + + /* GOAL : Returns the application URL */ + function GetApplicationURL () { + return ($this->sApplicationURL); + } + + /********************** APPLICATION NAME ************************* + ====================== Application name ("service" parameter) + GOAL : Set the application name. This will be displayed on the + Tequila login window. + IN : $sApplicationName -> string containing the application name + */ + function SetApplicationName ($sApplicationName) { + $this->sApplicationName = $sApplicationName; + } + + /* GOAL : returns the application name */ + function GetApplicationName () { + return ($this->sApplicationName); + } + + /*********************** RESOURCE NAME **************************** + GOAL : Set the resource name + IN : $sResource -> string with the resource name + */ + function SetResource ($sResource) { + $this->sResource = $sResource; + } + + /* GOAL : Returns the resource name */ + function GetResource () { + return ($this->sResource); + } + + /*********************** SESSION KEY ****************************** + GOAL : Set the session key + IN : $sKey -> string with the session key + */ + function SetKey ($sKey) { + $this->sKey = $sKey; + } + + /* GOAL : Returns the session key */ + function GetKey () { + return ($this->sKey); + } + + /*********************** SESSION MESSAGE ************************** + GOAL : Set the session message + IN : $sMessage -> string with the session message + */ + function SetMessage ($sMessage) { + $this->sMessage = $sMessage; + } + + /* GOAL : Returns the session message */ + function GetMessage () { + return ($this->sMessage); + } + + /************************ TEQUILA SERVER ************************** + ====================== server name + GOAL : Set tequila server name (i.e https://tequila.epfl.ch) + IN : $sServer -> the name + */ + function SetServer ($sServer) { + $this->sServer = $sServer; + } + + /* GOAL : Returns Tequila server's name */ + function GetServer () { + return ($this->sServer); + } + + /*====================== server URL + GOAL : Set tequila server URL (ie https://tequila.epfl.ch/cgi-bin/tequila) + IN : $sURL -> the url + */ + function SetServerURL ($sURL) { + $this->sServerUrl = $sURL; + } + + /* GOAL : Returns Tequila server's url */ + function GetServerURL () { + return ($this->sServerUrl); + } + + //====================== Session manager parameters + function SetTimeout ($iTimeout) { + $this->iTimeout = $iTimeout; + } + + function GetTimeout () { + return ($this->iTimeout); + } + + /************************ COOKIE PARAMETERS ********************* + GOAL : Set the cookie parameters. Very useful if you have page on your + website that have different access rights than the other pages. + Use this function to set the cookie name for thoses pages. + */ + /*====================== Cookie Life parameters + IN : $iCookieLife -> life of the cookie. + */ + function SetCookieLife ($iTimeout) { // Obsolete + $this->iCookieLife = $iTimeout; + } + + /*====================== Cookie Name parameters + IN : $sCookieName -> name of the cookie. + */ + function SetCookieName ($sCookieName) { + $this->sCookieName = $sCookieName; + } + + /************************ CREATE PHP SESSION ******************* + GOAL : Create a PHP session with the Tequila attributes + IN : $attributes -> an array containing the attributes returned + by the tequila server. + */ + function CreateSession ($attributes) { + if (!$attributes) return (FALSE); + foreach ($attributes as $key => $val) { + $this->aAttributes [$key] = $val; + $_SESSION [$key] = $val; + } + $_SESSION ['creation'] = time (); + return (TRUE); + } + + /* GOAL : Load or update a PHP session */ + function LoadSession () { + if (!isset ($_SESSION ['user'])) return (FALSE); + + /**** + Check if all the wanted attributes are present in the $_SESSION. + If at least one of the attribute is missing, we can consider that information + is missing in $_SESSION. In this case, we return false to "force" to create a new + session with the wanted attributes. This can happen when several website are + running on the same web server and all are using the PHP Tequila Client. + ****/ + + foreach ($this->aWantedAttributes as $wantedAttribute) { + if (!array_key_exists ($wantedAttribute, $_SESSION)) return false; + } + foreach ($this->aWishedAttributes as $wishedAttribute) { + if (!array_key_exists ($wishedAttribute, $_SESSION)) return false; + } + + $sesstime = time () - $_SESSION ['creation']; + if ($sesstime > $this->iTimeout) return (FALSE); + $this->sKey = $_SESSION ['key']; + return (TRUE); + } + + /************************* USER ATTRIBUTES *********************** + GOAL : Returns an array containing user's attributes names as indexes + and attributes values as values + @out : Array containing attributes names as indexes and + attributes values as values + */ + function GetAttributes() { + return ($this->aAttributes); + } + + /* GOAL : To know if the user's attributes are present or not. + @in : Array containing wanted attributes as keys + @out : The same array with TRUE or FALSE as value for the + corresponding attribute + */ + function HasAttributes (&$aAttributes) { + foreach ($aAttributes as $sAttribute => $sHasIt) + if (array_key_exists($sAttribute, $this->aAttributes)) + $aAttributes [$sAttribute] = TRUE; + else + $aAttributes [$sAttribute] = FALSE; + } + + /* GOAL : Launch the user authentication */ + function Authenticate () { + session_start (); + if ($this->LoadSession ()) return (TRUE); + if (isset ($_COOKIE [$this->sCookieName]) && !empty ($_COOKIE [$this->sCookieName])) { + $this->sKey = $_COOKIE [$this->sCookieName]; + $attributes = $this->fetchAttributes ($this->sKey); + if ($attributes) { + $this->CreateSession ($attributes); + return (TRUE); + } + } + $this->createRequest (); + setcookie ($this->sCookieName, $this->sKey); + $url = $this->getAuthenticationUrl (); + header ('Location: ' . $url); + exit; + } + + /* + GOAL : Sends an authentication request to Tequila + */ + function createRequest () { + $urlaccess = $this->sApplicationURL; + + /* If application URL not initialized, + we try to generate it automatically */ + if (empty ($urlaccess)) { + $urlaccess = ((isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] == 'on')) + ? 'https://' : 'http://') + . $_SERVER['SERVER_NAME'] . ":" . $_SERVER['SERVER_PORT'] . $_SERVER['PHP_SELF']; + if (isset($_SERVER['PATH_INFO'])) { + $urlaccess .= $_SERVER['PATH_INFO']; + } + if (isset($_SERVER['QUERY_STRING'])) { + $urlaccess .= '?' . $_SERVER['QUERY_STRING']; + } + } + + /* Request creation */ + $this->requestInfos ['urlaccess'] = $urlaccess; + + if (!empty ($this->sApplicationName)) + $this->requestInfos ['service'] = $this->sApplicationName; + if (!empty ($this->aWantedRights)) + $this->requestInfos ['wantright'] = implode($this->aWantedRights, '+'); + if (!empty ($this->aWantedRoles)) + $this->requestInfos ['wantrole'] = implode($this->aWantedRoles, '+'); + if (!empty ($this->aWantedAttributes)) + $this->requestInfos ['request'] = implode ($this->aWantedAttributes, '+'); + if (!empty ($this->aWishedAttributes)) + $this->requestInfos ['wish'] = implode ($this->aWishedAttributes, '+'); + if (!empty ($this->aWantedGroups)) + $this->requestInfos ['belongs'] = implode($this->aWantedGroups, '+'); + if (!empty ($this->sCustomFilter)) + $this->requestInfos ['require'] = $this->sCustomFilter; + if (!empty ($this->sAllowsFilter)) + $this->requestInfos ['allows'] = $this->sAllowsFilter; + if (!empty ($this->iLanguage)) + $this->requestInfos ['language'] = $this->aLanguages [$this->iLanguage]; + + $this->requestInfos ['dontappendkey'] = "1"; + + ob_end_clean(); + + /* Asking tequila */ + $response = $this->askTequila ('createrequest', $this->requestInfos); + $this->sKey = substr (trim ($response), 4); // 4 = strlen ('key=') + } + + /* GOAL : Returns current URL. + @return string + */ + function getCurrentUrl () { + return 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF']; + } + + /* GOAL : Checks that user has correctly authenticated and retrieves its data. + @return mixed + */ + function fetchAttributes ($sessionkey) { + $fields = array ('key' => $sessionkey); + $response = $this->askTequila ('fetchattributes', $fields); + if (!$response) return false; + + $result = array (); + $attributes = explode ("\n", $response); + + /* Saving returned attributes */ + foreach ($attributes as $attribute) { + $attribute = trim ($attribute); + if (!$attribute) continue; + list ($key, $val) = explode ('=', $attribute,2); + //if ($key == 'key') { $this->key = $val; } + //if ($key == 'org') { $this->org = $val; } + //if ($key == 'user') { $this->user = $val; } + //if ($key == 'host') { $this->host = $val; } + $result [$key] = $val; + } + return $result; + } + + /** + * Returns the value of $key. + * $key is a Tequila attribute. + * @return string + */ + function getValue ($key = ''){ + if (isset ($_SESSION [$key])) return $_SESSION [$key]; + } + + /*GOAL : Gets tequila server config infos */ + function getConfig () { + return $this->askTequila ('config'); + } + + /*GOAL : Returns the Tequila authentication form URL. + @return string + */ + function getAuthenticationUrl () { + //return sprintf('%s/requestauth?requestkey=%s', + // $this->sServerUrl, + // $this->sKey); + return sprintf('%s/requestauth?requestkey=%s', + $this->sServerUrl, + $this->sKey); + } + + /* + GOAL : Returns the logout URL + IN : $redirectUrl -> (optional) the url to redirect to when logout is done + */ + function getLogoutUrl ($redirectUrl = '') { + $url = sprintf('%s/logout', $this->sServerUrl); + if (!empty($redirectUrl)) { + $url .= "?urlaccess=" . urlencode ($redirectUrl); + } + return $url; + } + + /* + GOAL : Destroy the session file + */ + function KillSessionFile() { + if(!empty($_SESSION)){ + session_destroy(); + } + } + + /* + GOAL : Destroy session cookie + */ + function KillSessionCookie() { + // Delete cookie by setting expiration time in the past with root path + setcookie($this->sCookieName, '', time()-3600, '/'); + } + + /* + GOAL : terminate a session + */ + function KillSession() { + $this->KillSessionFile(); + $this->KillSessionCookie(); + } + + /* + GOAL : Logout from tequila + */ + function Logout ($redirectUrl = '') { + // Kill session cookie and session file + $this->KillSession(); + // Redirect the user to the tequila server logout url + header("Location: " . $this->getLogoutUrl($redirectUrl)); + } + + /* + GOAL : contact tequila + IN : $type -> the type of contact to have with tequila + N : $fields -> an array with the information for the request + to Tequila server + */ + function askTequila ($type, $fields = array()) { + //Use the CURL object in order to communicate with tequila.epfl.ch + $ch = curl_init (); + + curl_setopt ($ch, CURLOPT_HEADER, false); + curl_setopt ($ch, CURLOPT_POST, true); + curl_setopt ($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, false); + curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, false); + + if ($this->sCAFile) curl_setopt ($ch, CURLOPT_CAINFO, $this->sCAFile); + if ($this->sCertFile) curl_setopt ($ch, CURLOPT_SSLCERT, $this->sCertFile); + if ($this->sKeyFile) curl_setopt ($ch, CURLOPT_SSLKEY, $this->sKeyFile); + + $url = $this->sServerUrl; + switch ($type) { + case 'createrequest': + $url .= '/createrequest'; + break; + + case 'fetchattributes': + $url .= '/fetchattributes'; + break; + + case 'config': + $url .= '/getconfig'; + break; + + case 'logout': + $url .= '/logout'; + break; + + default: + return; + } + // $url contains the tequila server with the parameters to execute + curl_setopt ($ch, CURLOPT_URL, $url); + + /* If fields where passed as parameters, */ + if (is_array ($fields) && count ($fields)) { + $pFields = array (); + foreach ($fields as $key => $val) { + $pFields[] = sprintf('%s=%s', $key, $val); + } + $query = implode("\n", $pFields) . "\n"; + curl_setopt ($ch, CURLOPT_POSTFIELDS, $query); + } + $response = curl_exec ($ch); + // If connexion failed (HTTP code 200 <=> OK) + if (curl_getinfo ($ch, CURLINFO_HTTP_CODE) != '200') { + $response = false; + } + curl_close ($ch); + return $response; + } +} + +?> diff --git a/src/tequila_config.inc.php b/src/tequila_config.inc.php new file mode 100644 index 0000000..11304b8 --- /dev/null +++ b/src/tequila_config.inc.php @@ -0,0 +1,19 @@ + 'https://tequila.epfl.ch', + 'iTimeout' => 86400, + 'logoutUrl' => "https://localhost/tequila/logout.php", + ); + + +/******************************************************** + DO NOT EDIT UNDER THIS LINE +********************************************************/ +function GetConfigOption($sOption, $sDefault = '') { + global $aConfig; + if (!array_key_exists ($sOption, $aConfig)) + return ($sDefault); + else + return ($aConfig [$sOption]); +} +?> diff --git a/src/test.php b/src/test.php new file mode 100644 index 0000000..9439d0e --- /dev/null +++ b/src/test.php @@ -0,0 +1,48 @@ +SetApplicationName('Les élèves vont à l\'école'); +$oClient->SetWantedAttributes(array('uniqueid','name','firstname','unit', 'unitid', 'where', 'group')); +$oClient->SetWishedAttributes(array('email', 'title')); +#$oClient->SetApplicationURL('https://localhost/tequila/test.php'); +#$oClient->SetCustomFilter('org=EPFL&firstname=John&unit=SC-PME&where=SC-PME/SC-S/ETU/EPFL/CH&group=inbc'); +$oClient->SetCustomParamaters(array ('toto' => 1)); + +$oClient->Authenticate (); + +$org = $oClient->getValue('org'); +$user = $oClient->getValue('user'); +$host = $oClient->getValue('host'); +$sKey = $oClient->GetKey(); + +echo << + + Test Tequila + + +

Test Tequila :

+ 
+             key = $sKey
+             org = $org
+            user = $user
+            host = $host
+
+EOT;
+
+echo "\nCookies = ";
+print_r($_COOKIE);
+echo "\nSession = ";
+print_r($_SESSION);
+
+echo <<
+		

+		Test session key

+	
+
+
+EOT;
+?>