BxAzrConModule.php 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup AzureConnect Azure Connect
  7. * @ingroup UnaModules
  8. *
  9. * @{
  10. */
  11. /**
  12. * This Azude AD connect code was created with instructions from:
  13. * https://www.sipponen.com/archives/4024
  14. */
  15. class BxAzrConModule extends BxBaseModConnectModule
  16. {
  17. function __construct(&$aModule)
  18. {
  19. parent::__construct($aModule);
  20. }
  21. /**
  22. * Redirect to remote site login form
  23. *
  24. * @return n/a - redirect or HTML page in case of error
  25. */
  26. function actionStart()
  27. {
  28. if (isset($_GET["error"])) {
  29. $this->_oTemplate->getPage(_t($this->_oConfig->sDefaultTitleLangKey), DesignBoxContent(_t($this->_oConfig->sDefaultTitleLangKey), MsgBox(bx_get('error'))));
  30. exit;
  31. }
  32. if (isLogged()) {
  33. $this->_redirect ($this -> _oConfig -> sDefaultRedirectUrl);
  34. }
  35. if (!$this->_oConfig->sClientID || !$this->_oConfig->sSecret) {
  36. require_once(BX_DIRECTORY_PATH_INC . 'design.inc.php');
  37. bx_import('BxDolLanguages');
  38. $sCode = MsgBox( _t('_bx_azrcon_profile_error_api_keys') );
  39. $this->_oTemplate->getPage(_t('_bx_azrcon'), $sCode);
  40. }
  41. else {
  42. // First stage of the authentication process; This is just a simple redirect (first load of this page)
  43. $sUrl = bx_append_url_params("https://login.microsoftonline.com/" . $this->_oConfig->sTenantID . "/oauth2/v2.0/authorize", [
  44. 'state' => $this->_genToken(), // BxDolSession::getInstance()->getId(), // This at least semi-random string is likely good enough as state identifier
  45. 'scope' => $this->_oConfig->sScope, // User.Read scope seems to be enough, but you can try "&scope=profile+openid+email+offline_access+User.Read" if you like
  46. 'response_type' => 'code',
  47. 'approval_prompt' => 'auto',
  48. 'client_id' => $this->_oConfig->sClientID,
  49. 'redirect_uri' => $this->_oConfig->sPageHandle,
  50. ]);
  51. $this->_redirect($sUrl); // So off you go my dear browser and welcome back for round two after some redirects at Azure end
  52. }
  53. }
  54. function actionHandle()
  55. {
  56. require_once(BX_DIRECTORY_PATH_INC . 'design.inc.php');
  57. // check CSRF token
  58. if ($this->_getToken() != bx_get('state')) {
  59. $this->_oTemplate->getPage(_t('_Error'), MsgBox(_t('_sys_connect_state_invalid')));
  60. return;
  61. }
  62. // check code
  63. $sCode = bx_get('code');
  64. if (!$sCode || bx_get('error')) {
  65. $sErrorDescription = bx_get('error_description') ? bx_get('error_description') : _t('_error occured');
  66. $this->_oTemplate->getPage(_t('_Error'), MsgBox($sErrorDescription));
  67. return;
  68. }
  69. // Verifying the received tokens with Azure and finalizing the authentication part
  70. $s = bx_file_get_contents("https://login.microsoftonline.com/" . $this->_oConfig->sTenantID . "/oauth2/v2.0/token", [
  71. 'grant_type' => 'authorization_code',
  72. 'client_id' => $this->_oConfig->sClientID,
  73. 'redirect_uri' => $this->_oConfig->sPageHandle,
  74. 'code' => $sCode,
  75. 'client_secret' => $this->_oConfig->sSecret,
  76. ], 'post', array ('Content-Type: application/x-www-form-urlencoded'));
  77. // handle error
  78. if (!$s || NULL === ($aAuthData = json_decode($s, true)) || !isset($aAuthData['access_token']) || isset($aAuthData['error'])) {
  79. $sErrorDescription = isset($aAuthData['error_description']) ? $aAuthData['error_description'] : _t('_error occured');
  80. $this->_oTemplate->getPage(_t('_Error'), MsgBox($sErrorDescription));
  81. return;
  82. }
  83. // get the data, especially access_token
  84. $sAccessToken = $aAuthData['access_token'];
  85. $sExpiresIn = $aAuthData['expires_in'];
  86. $sExpiresAt = new \DateTime('+' . $sExpiresIn . ' seconds');
  87. // request info about profile
  88. // In case you need some other attributes from the user object that are not coming with "/me" by default, you can use $select argument at line 74 to select the properties you really need:
  89. // https://graph.microsoft.com/v1.0/me?$select=givenName,surname,userPrincipalName,country
  90. $s = bx_file_get_contents("https://graph.microsoft.com/v1.0/me", array(), 'get', array(
  91. 'Accept: application/json',
  92. 'Authorization: Bearer ' . $sAccessToken,
  93. ));
  94. // handle error
  95. if (!$s || NULL === ($aUserData = json_decode($s, true)) || !$aUserData || isset($aUserData['error'])) {
  96. $sErrorDescription = isset($aUserData['error_description']) ? $aUserData['error_description'] : _t('_error occured');
  97. $this->_oTemplate->getPage(_t('_Error'), MsgBox($sErrorDescription));
  98. return;
  99. }
  100. $aRemoteProfileInfo = $aUserData;
  101. if ($aRemoteProfileInfo) {
  102. // check if user logged in before
  103. $iLocalProfileId = $this->_oDb->getProfileId($aRemoteProfileInfo['id']);
  104. if ($iLocalProfileId && $oProfile = BxDolProfile::getInstance($iLocalProfileId)) {
  105. // user already exists
  106. $this->setLogged($oProfile ->id());
  107. }
  108. else {
  109. // register new user
  110. $this->_createProfile($aRemoteProfileInfo);
  111. }
  112. }
  113. else {
  114. $this->_oTemplate->getPage(_t('_Error'), MsgBox(_t('_sys_connect_profile_error_info')));
  115. }
  116. }
  117. /**
  118. * @param $aProfileInfo - remote profile info
  119. * @param $sAlternativeName - suffix to add to NickName to make it unique
  120. * @return profile array info, ready for the local database
  121. */
  122. protected function _convertRemoteFields($aProfileInfo, $sAlternativeName = '')
  123. {
  124. $aProfileFields = $aProfileInfo;
  125. $a = explode('@', $aProfileInfo['userPrincipalName']);
  126. $sName = isset($a[0]) ? $a[0] : $aProfileInfo['userPrincipalName'];
  127. $aProfileFields['name'] = !empty($aProfileInfo['displayName']) ? $aProfileInfo['displayName'] : $sName;
  128. $aProfileFields['fullname'] = !empty($aProfileInfo['givenName']) ? $aProfileInfo['givenName'] : $aProfileFields['name'];
  129. $aProfileFields['last_name'] = !empty($aProfileInfo['surname']) ? ' ' . $aProfileInfo['surname'] : '';
  130. $aProfileFields['email'] = isset($aProfileInfo['mail']) ? $aProfileInfo['mail'] : $aProfileInfo['userPrincipalName'];
  131. $aProfileFields['picture'] = ''; // isset($aProfileInfo['picture']) ? $aProfileInfo['picture'] : '';
  132. $aProfileFields['allow_view_to'] = getParam('bx_azrcon_privacy');
  133. return $aProfileFields;
  134. }
  135. }
  136. /** @} */