ldap.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. <form action="/_api/admin/security/passport-ldap" method="post" class="form-horizontal" id="ldapSetting" role="form">
  2. <fieldset>
  3. <legend>LDAP Configuration</legend>
  4. {% set nameForIsLdapEnabled = "settingForm[security:passport-ldap:isEnabled]" %}
  5. {% set isLdapEnabled = settingForm['security:passport-ldap:isEnabled'] %}
  6. <div class="form-group">
  7. <label for="{{nameForIsLdapEnabled}}" class="col-xs-3 control-label">Use LDAP</label>
  8. <div class="col-xs-6">
  9. <div class="btn-group btn-toggle" data-toggle="buttons">
  10. <label class="btn btn-default btn-rounded btn-outline {% if isLdapEnabled %}active{% endif %}" data-active-class="primary">
  11. <input name="{{nameForIsLdapEnabled}}" value="true" type="radio"
  12. {% if true === isLdapEnabled %}checked{% endif %}> ON
  13. </label>
  14. <label class="btn btn-default btn-rounded btn-outline {% if !isLdapEnabled %}active{% endif %}" data-active-class="default">
  15. <input name="{{nameForIsLdapEnabled}}" value="false" type="radio"
  16. {% if !isLdapEnabled %}checked{% endif %}> OFF
  17. </label>
  18. </div>
  19. </div>
  20. </div>
  21. <div class="passport-ldap-hide-when-disabled" {%if !isLdapEnabled %}style="display: none;"{% endif %}>
  22. <div class="form-group">
  23. <label for="settingForm[security:passport-ldap:serverUrl]" class="col-xs-3 control-label">Server URL</label>
  24. <div class="col-xs-6">
  25. <input class="form-control" type="text"
  26. name="settingForm[security:passport-ldap:serverUrl]" value="{{ settingForm['security:passport-ldap:serverUrl'] || '' }}">
  27. <p class="help-block">
  28. <small>
  29. The LDAP URL of the directory service in the format <code>ldap://host:port/DN</code> or <code>ldaps://host:port/DN</code>.<br>
  30. Example: <code>ldaps://ldap.company.com/ou=people,dc=company,dc=com</code>
  31. </small>
  32. </p>
  33. </div>
  34. </div>
  35. {% set nameForIsUserBind = "settingForm[security:passport-ldap:isUserBind]" %}
  36. {% set isUserBind = settingForm['security:passport-ldap:isUserBind'] %}
  37. <div class="form-group">
  38. <label for="{{nameForIsUserBind}}" class="col-xs-3 control-label">Binding Mode</label>
  39. <div class="col-xs-6">
  40. <div class="btn-group btn-toggle" data-toggle="buttons">
  41. <label class="btn btn-default btn-rounded btn-outline {% if !isUserBind %}active{% endif %}" data-active-class="primary">
  42. <input name="{{nameForIsUserBind}}" value="false" type="radio"
  43. {% if !isUserBind %}checked{% endif %}> Manager Bind
  44. </label>
  45. <label class="btn btn-default btn-rounded btn-outline {% if isUserBind %}active{% endif %}" data-active-class="primary">
  46. <input name="{{nameForIsUserBind}}" value="true" type="radio"
  47. {% if isUserBind %}checked{% endif %}> User Bind
  48. </label>
  49. </div>
  50. </div>
  51. </div>
  52. <div class="form-group">
  53. <label for="settingForm[security:passport-ldap:bindDN]" class="col-xs-3 control-label">Bind DN</label>
  54. <div class="col-xs-6">
  55. <input class="form-control" type="text"
  56. name="settingForm[security:passport-ldap:bindDN]" value="{{ settingForm['security:passport-ldap:bindDN'] || '' }}">
  57. <p class="help-block passport-ldap-managerbind" {% if isUserBind %}style="display: none;"{% endif %}>
  58. <small>
  59. The DN of the account that authenticates and queries the directory service
  60. </small>
  61. </p>
  62. <p class="help-block passport-ldap-userbind" {% if !isUserBind %}style="display: none;"{% endif %}>
  63. <small>
  64. The query used to bind with the directory service.<br>
  65. Use <code>{% raw %}{{username}}{% endraw %}</code> to reference the username entered in the login page.<br>
  66. Example: <code>uid={% raw %}{{username}}{% endraw %},dc=domain,dc=com</code><br>
  67. </small>
  68. </p>
  69. </div>
  70. </div>
  71. <div class="form-group">
  72. <label for="settingForm[security:passport-ldap:bindDNPassword]" class="col-xs-3 control-label">Bind DN Password</label>
  73. <div class="col-xs-6">
  74. <input class="form-control passport-ldap-managerbind" type="text" {% if isUserBind %}style="display: none;"{% endif %}
  75. name="settingForm[security:passport-ldap:bindDNPassword]" value="{{ settingForm['security:passport-ldap:bindDNPassword'] || '' }}">
  76. <p class="help-block passport-ldap-managerbind">
  77. <small>
  78. The password for the Bind DN account.
  79. </small>
  80. </p>
  81. <p class="help-block passport-ldap-userbind" {% if !isUserBind %}style="display: none;"{% endif %}>
  82. <small>
  83. The password that is entered in the login page will be used to bind.
  84. </small>
  85. </p>
  86. </div>
  87. </div>
  88. <div class="form-group">
  89. <label for="settingForm[security:passport-ldap:searchFilter]" class="col-xs-3 control-label">Search Filter</label>
  90. <div class="col-xs-6">
  91. <input class="form-control" type="text" placeholder="Default: (uid={% raw %}{{username}}{% endraw %})"
  92. name="settingForm[security:passport-ldap:searchFilter]" value="{{ settingForm['security:passport-ldap:searchFilter'] || '' }}">
  93. <p class="help-block">
  94. <small>
  95. The query used to locate the authenticated user.<br>
  96. Use <code>{% raw %}{{username}}{% endraw %}</code> to reference the username entered in the login page.<br>
  97. If empty, the filter <code>(uid={% raw %}{{username}}{% endraw %})</code> is used.<br>
  98. <br>
  99. Example to match with 'uid' or 'mail': <code>(|(uid={% raw %}{{username}}{% endraw %})(mail={% raw %}{{username}}{% endraw %}))</code>
  100. </small>
  101. </p>
  102. </div>
  103. </div>
  104. <h4>Attribute Mapping (Optional)</h4>
  105. <div class="form-group">
  106. <label for="settingForm[security:passport-ldap:attrMapUsername]" class="col-xs-3 control-label">username</label>
  107. <div class="col-xs-6">
  108. <input class="form-control" type="text" placeholder="Default: uid"
  109. name="settingForm[security:passport-ldap:attrMapUsername]" value="{{ settingForm['security:passport-ldap:attrMapUsername'] || '' }}">
  110. <p class="help-block">
  111. <small>
  112. Specification of mappings when creating new users
  113. </small>
  114. </p>
  115. <div class="checkbox checkbox-info">
  116. <input type="checkbox" id="cbSameUsernameTreatedAsIdenticalUser" name="settingForm[security:passport-ldap:isSameUsernameTreatedAsIdenticalUser]" value="1"
  117. {% if settingForm['security:passport-ldap:isSameUsernameTreatedAsIdenticalUser'] %}checked{% endif %} />
  118. <label for="cbSameUsernameTreatedAsIdenticalUser">
  119. {{ t("security_setting.Treat username matching as identical") }}
  120. </label>
  121. </div>
  122. </div>
  123. </div>
  124. <h4>Group Search Filter (Optional)</h4>
  125. <div class="form-group">
  126. <label for="settingForm[security:passport-ldap:groupSearchBase]" class="col-xs-3 control-label">Group Search Base DN</label>
  127. <div class="col-xs-6">
  128. <input class="form-control" type="text"
  129. name="settingForm[security:passport-ldap:groupSearchBase]" value="{{ settingForm['security:passport-ldap:groupSearchBase'] || '' }}">
  130. <p class="help-block">
  131. <small>
  132. The base DN from which to search for groups. If defined, also <code>Group Search Filter</code> must be defined for the search to work.<br>
  133. Example: <code>ou=groups,dc=domain,dc=com</code><br>
  134. </small>
  135. </p>
  136. </div>
  137. </div>
  138. <div class="form-group">
  139. <label for="settingForm[security:passport-ldap:groupSearchFilter]" class="col-xs-3 control-label">Group Search Filter</label>
  140. <div class="col-xs-6">
  141. <input class="form-control" type="text"
  142. name="settingForm[security:passport-ldap:groupSearchFilter]" value="{{ settingForm['security:passport-ldap:groupSearchFilter'] || '' }}">
  143. <p class="help-block">
  144. <small>
  145. The query used to filter for groups.<br>
  146. Use <code>{% raw %}{{dn}}{% endraw %}</code> to have it replaced of the found user object.<br>
  147. <br>
  148. Example: <code>(&(cn=group1)(memberUid={% raw %}{{dn}}{% endraw %}))</code> hits the groups
  149. which has <code>cn=group1</code> and <code>memberUid</code> includes the user's <code>uid</code>
  150. (when <code>Group DN Property</code> is not changed from the default value.)
  151. </small>
  152. </p>
  153. </div>
  154. </div>
  155. <div class="form-group">
  156. <label for="settingForm[security:passport-ldap:groupSearchFilter]" class="col-xs-3 control-label">Group DN Property</label>
  157. <div class="col-xs-6">
  158. <input class="form-control" type="text" placeholder="Default: uid"
  159. name="settingForm[security:passport-ldap:groupDnProperty]" value="{{ settingForm['security:passport-ldap:groupDnProperty'] || '' }}">
  160. <p class="help-block">
  161. <small>
  162. The property of user object to use in <code>{% raw %}{{dn}}{% endraw %}</code> interpolation of <code>Group Search Filter</code>.
  163. </small>
  164. </p>
  165. </div>
  166. </div>
  167. </div><!-- /.passport-ldap-configurations -->
  168. <div class="form-group">
  169. <div class="col-xs-offset-3 col-xs-6">
  170. <button type="submit" class="btn btn-primary">{# the first element is the default button to submit #}
  171. {{ t('Update') }}
  172. </button>
  173. <button type="button"
  174. class="btn btn-default passport-ldap-hide-when-disabled"
  175. data-target="#test-ldap-account" data-toggle="modal"
  176. {%if !isLdapEnabled %}style="display: none;"{% endif %}>
  177. Test Saved Configuration
  178. </button>
  179. </div>
  180. </div>
  181. </fieldset>
  182. <input type="hidden" name="_csrf" value="{{ csrf() }}">
  183. <script>
  184. // switch display according to on / off of radio buttons
  185. $('input[name="{{nameForIsLdapEnabled}}"]:radio').change(function() {
  186. const isEnabled = ($(this).val() === "true");
  187. if (isEnabled) {
  188. $('.passport-ldap-hide-when-disabled').show(400);
  189. }
  190. else {
  191. $('.passport-ldap-hide-when-disabled').hide(400);
  192. }
  193. });
  194. // switch display according to on / off of radio buttons
  195. $('input[name="{{nameForIsUserBind}}"]:radio').change(function() {
  196. const isUserBind = ($(this).val() === "true");
  197. if (isUserBind) {
  198. $('input.passport-ldap-managerbind').hide();
  199. $('.help-block.passport-ldap-managerbind').hide();
  200. $('.help-block.passport-ldap-userbind').show();
  201. }
  202. else {
  203. $('input.passport-ldap-managerbind').show();
  204. $('.help-block.passport-ldap-managerbind').show();
  205. $('.help-block.passport-ldap-userbind').hide();
  206. }
  207. });
  208. // store which button is clicked when submit
  209. var submittedButton;
  210. $('button[type="submit"]').click(function() {
  211. submittedButton = $(this);
  212. });
  213. $('#ldapSetting, #ldapTest').each(function() {
  214. $(this).submit(function()
  215. {
  216. function showMessage(formId, msg, status) {
  217. $('#' + formId + ' .alert').remove();
  218. if (!status) {
  219. status = 'success';
  220. }
  221. var $message = $('<p class="alert"></p>');
  222. $message.addClass('alert-' + status);
  223. $message.html(msg.replace('\n', '<br>'));
  224. $message.insertAfter('#' + formId + ' legend');
  225. if (status == 'success') {
  226. setTimeout(function()
  227. {
  228. $message.fadeOut({
  229. complete: function() {
  230. $message.remove();
  231. }
  232. });
  233. }, 5000);
  234. }
  235. }
  236. var $form = $(this);
  237. var $id = $form.attr('id');
  238. var $button = submittedButton;
  239. var $action = $button.attr('formaction') || $form.attr('action');
  240. $button.attr('disabled', 'disabled');
  241. var jqxhr = $.post($action, $form.serialize(), function(data)
  242. {
  243. if (data.status) {
  244. const message = data.message || '更新しました';
  245. showMessage($id, message);
  246. } else {
  247. showMessage($id, data.message, 'danger');
  248. }
  249. })
  250. .fail(function() {
  251. showMessage($id, 'エラーが発生しました', 'danger');
  252. })
  253. .always(function() {
  254. $button.prop('disabled', false);
  255. });
  256. return false;
  257. });
  258. });
  259. </script>
  260. </form>
  261. <div class="modal test-ldap-account" id="test-ldap-account">
  262. <div class="modal-dialog">
  263. <div class="modal-content">
  264. <div class="modal-header">
  265. <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
  266. <div class="modal-title">{{ t('Test LDAP Account') }}</div>
  267. </div>
  268. <div class="modal-body">
  269. {% include '../../../widget/passport/ldap-association-tester.html' %}
  270. </div><!-- /.modal-body -->
  271. </div><!-- /.modal-content -->
  272. </div><!-- /.modal-dialog -->
  273. <script>
  274. /**
  275. * associate (submit the form)
  276. */
  277. function associateLdap() {
  278. var $form = $('#formLdapAssociationContainer > form');
  279. var $action = '/me/external-accounts/associateLdap';
  280. $form.attr('action', $action);
  281. $form.submit();
  282. }
  283. </script>
  284. </div><!-- /.modal -->