CA-422713: XSI-2105: Pool.join failed due to AD status corrupt

The target pool has leaved AD, the joining host leave AD as well.
However, the AD status is somehow corrupt
- external_auth_type is empty, this is expected
- external_auth_service_name is a valid domain

This confused pool.join as it thinks AD is not enabled, but
somehow joined to a domain.

- Normal domain leave does not resolve the issue, and it does not
join domain
- Join domain again(failed) does not resolve it neither, as xapi will
restore to the current value before join on failed.

This commit introduce force option to host.disable_external_auth API
to force clean up to recover host

BTW, current code try to keep them consistent already, but not atomic.

Signed-off-by: Lin Liu <lin.liu01@citrix.com>

Author: Lin Liu

ocaml/idl/datamodel_host.ml

@@ -2033,6 +2033,13 @@ let disable_external_auth =
         ; param_release= george_release
         ; param_default= Some (VMap [])
         }
+      ; {
+          param_type= Bool
+        ; param_name= "force"
+        ; param_doc= "Disable external auth even not enabled"
+        ; param_release= numbered_release "26.1.0-next"
+        ; param_default= Some (VBool false)
+        }
       ]
     ~doc:"This call disables external authentication on the local host"
     ~allowed_roles:_R_POOL_ADMIN ()

ocaml/xapi-cli-server/cli_operations.ml

@@ -7089,7 +7089,7 @@ let host_disable_external_auth _printer rpc session_id params =
   let host_uuid = List.assoc "host-uuid" params in
   let host = Client.Host.get_by_uuid ~rpc ~session_id ~uuid:host_uuid in
   let config = read_map_params "config" params in
-  Client.Host.disable_external_auth ~rpc ~session_id ~host ~config
+  Client.Host.disable_external_auth ~rpc ~session_id ~host ~config ~force:true
 
 let host_refresh_pack_info _printer rpc session_id params =
   let host_uuid = List.assoc "host-uuid" params in

ocaml/xapi/message_forwarding.ml

@@ -3730,11 +3730,13 @@ functor
         in
         do_op_on ~local_fn ~__context ~host ~remote_fn
 
-      let disable_external_auth ~__context ~host ~config =
+      let disable_external_auth ~__context ~host ~config ~force =
         info "Host.disable_external_auth: host = '%s'"
           (host_uuid ~__context host) ;
-        let local_fn = Local.Host.disable_external_auth ~host ~config in
-        let remote_fn = Client.Host.disable_external_auth ~host ~config in
+        let local_fn = Local.Host.disable_external_auth ~host ~config ~force in
+        let remote_fn =
+          Client.Host.disable_external_auth ~host ~config ~force
+        in
         do_op_on ~local_fn ~__context ~host ~remote_fn
 
       let install_ca_certificate ~__context ~host ~name ~cert =

ocaml/xapi/xapi_host.ml

@@ -1889,13 +1889,13 @@ let enable_external_auth ~__context ~host ~config ~service_name ~auth_type =
 
 (* CP-718: Disables external auth/directory service for host *)
 let disable_external_auth_common ?(during_pool_eject = false) ~__context ~host
-    ~config () =
+    ~config ~force () =
   (* CP-825: Serialize execution of host-enable-extauth and host-disable-extauth *)
   (* we need to protect against concurrent access to the host.external_auth_type variable *)
   with_lock serialize_host_enable_disable_extauth (fun () ->
       let host_name_label = Db.Host.get_name_label ~__context ~self:host in
       let auth_type = Db.Host.get_external_auth_type ~__context ~self:host in
-      if auth_type = "" then
+      if auth_type = "" && not force then
         (* nothing to do, external authentication is already disabled *)
         let msg = "external authentication service is already disabled" in
         debug "Failed to disable external authentication in host %s: %s"
@@ -1936,6 +1936,8 @@ let disable_external_auth_common ?(during_pool_eject = false) ~__context ~host
                    , [msg]
                    )
                 )
+          | Extauth_is_disabled ->
+              Some Extauth_is_disabled
           | e ->
               (*absorb any exception*)
               debug
@@ -1957,19 +1959,6 @@ let disable_external_auth_common ?(during_pool_eject = false) ~__context ~host
         Xapi_globs.event_hook_auth_on_xapi_initialize_succeeded := true ;
 
         (* succeeds because there's no need to initialize anymore *)
-
-        (* If any cache is present, clear it in order to ensure cached
-           logins don't persist after disabling external
-           authentication. *)
-        Xapi_session.clear_external_auth_cache () ;
-
-        (* 3. CP-703: we always revalidate all sessions after the external authentication has been disabled *)
-        (* so that all sessions that were externally authenticated will be destroyed *)
-        debug
-          "calling revalidate_all_sessions after disabling external auth for \
-           host %s"
-          host_name_label ;
-        Xapi_session.revalidate_all_sessions ~__context ;
         if not during_pool_eject then
           (* CA-28168 *)
           (* CA-24856: detect non-homogeneous external-authentication config in this host *)
@@ -1978,19 +1967,18 @@ let disable_external_auth_common ?(during_pool_eject = false) ~__context ~host
         if auth_type = Xapi_globs.auth_type_AD then
           Extauth_ad.stop_backend_daemon ~wait_until_success:false ;
         match plugin_disable_failure with
-        | None ->
+        (* we do not want to stop pool_eject and permit Extauth_is_disabled during force *)
+        | Some e when during_pool_eject || (e = Extauth_is_disabled && force) ->
             ()
         | Some e ->
-            if not during_pool_eject then
-              raise e (* bubble up plugin's on_disable exception *)
-            else
-              ()
-      (* we do not want to stop pool_eject *)
+            raise e
+        | None ->
+            ()
   )
 
-let disable_external_auth ~__context ~host ~config =
+let disable_external_auth ~__context ~host ~config ~force =
   disable_external_auth_common ~during_pool_eject:false ~__context ~host ~config
-    ()
+    ~force ()
 
 module Static_vdis_list = Xapi_database.Static_vdis_list
 

ocaml/xapi/xapi_host.mli

@@ -361,13 +361,15 @@ val disable_external_auth_common :
   -> __context:Context.t
   -> host:API.ref_host
   -> config:(string * string) list
+  -> force:bool
   -> unit
   -> unit
 
 val disable_external_auth :
      __context:Context.t
   -> host:API.ref_host
   -> config:(string * string) list
+  -> force:bool
   -> unit
 
 (** {2 Static VDIs} *)

ocaml/xapi/xapi_pool.ml

@@ -2037,7 +2037,7 @@ let eject_self ~__context ~host =
     (* disable the external authentication of this slave being ejected *)
     (* this call will return an exception if something goes wrong *)
     Xapi_host.disable_external_auth_common ~during_pool_eject:true ~__context
-      ~host ~config:[] () ;
+      ~host ~config:[] ~force:false () ;
 
     (* FIXME: in the future, we should send the windows AD admin/pass here *)
     (* in order to remove the slave from the AD database during pool-eject *)
@@ -2973,7 +2973,7 @@ let enable_external_auth ~__context ~pool:_ ~config ~service_name ~auth_type =
                     (* best-effort attempt to disable all enabled hosts, swallowing any exceptions *)
                     try
                       call_fn_on_host ~__context
-                        (Client.Host.disable_external_auth ~config)
+                        (Client.Host.disable_external_auth ~config ~force:false)
                         host
                     with e ->
                       debug
@@ -3041,7 +3041,7 @@ let disable_external_auth ~__context ~pool:_ ~config =
             (* forward the call to the host in the pool *)
             try
               call_fn_on_host ~__context
-                (Client.Host.disable_external_auth ~config)
+                (Client.Host.disable_external_auth ~config ~force:false)
                 host ;
               (* no failed host to add to the filtered list, just visit next host *)
               (host, "", "")
@@ -3100,9 +3100,21 @@ let disable_external_auth ~__context ~pool:_ ~config =
                    )
                 )
       ) else (* OK *)
+        (
+        (* If any cache is present, clear it in order to ensure cached
+           logins don't persist after disabling external
+           authentication. *)
+        Xapi_session.clear_external_auth_cache () ;
+
+        (* CP-703: we always revalidate all sessions after the external authentication has been disabled *)
+        (* so that all sessions that were externally authenticated will be destroyed *)
+        debug "calling revalidate_all_sessions after disabling external auth" ;
+        Xapi_session.revalidate_all_sessions ~__context ;
+
         debug
           "The external authentication of all hosts in the pool was disabled \
            successfully"
+      )
   )
 
 (* CA-24856: detect non-homogeneous external-authentication config in pool *)