Revert "BREAKING CHANGE: remove btool and replace it with splunk.rest"

Author: hetangmodi-crest

docs/release_7_0_0.md

@@ -31,7 +31,6 @@ plugins:
 nav:
   - Home: index.md
   - Release 6.0.0: release_6_0_0.md
-  - Release 7.0.0: release_7_0_0.md
   - References:
       - modular_input:
           - "checkpointer.py": modular_input/checkpointer.md

mkdocs.yml

@@ -16,19 +16,23 @@
 
 """This module contains Splunk credential related interfaces."""
 
+import json
 import re
 import warnings
 from typing import Dict, List
 
 from splunklib import binding, client
 
 from . import splunk_rest_client as rest_client
+from .net_utils import validate_scheme_host_port
+from .splunkenv import get_splunkd_access_info
 from .utils import retry
 
 __all__ = [
     "CredentialException",
     "CredentialNotExistException",
     "CredentialManager",
+    "get_session_key",
 ]
 
 
@@ -335,3 +339,56 @@ def _get_all_passwords(self) -> List[Dict[str, str]]:
         )
         passwords = self._storage_passwords.list(count=-1)
         return self._get_clear_passwords(passwords)
+
+
+@retry(exceptions=[binding.HTTPError])
+def get_session_key(
+    username: str,
+    password: str,
+    scheme: str = None,
+    host: str = None,
+    port: int = None,
+    **context: dict,
+) -> str:
+    """Get splunkd access token.
+
+    Arguments:
+        username: The Splunk account username, which is used to authenticate the Splunk instance.
+        password: The Splunk account password.
+        scheme: (optional) The access scheme, default is None.
+        host: (optional) The host name, default is None.
+        port: (optional) The port number, default is None.
+        context: Other configurations for Splunk rest client.
+
+    Returns:
+        Splunk session key.
+
+    Raises:
+        CredentialException: If username/password are invalid.
+        ValueError: if scheme, host or port are invalid.
+
+    Examples:
+       >>> get_session_key('user', 'password')
+    """
+    validate_scheme_host_port(scheme, host, port)
+
+    if any([scheme is None, host is None, port is None]):
+        scheme, host, port = get_splunkd_access_info()
+
+    uri = "{scheme}://{host}:{port}/{endpoint}".format(
+        scheme=scheme, host=host, port=port, endpoint="services/auth/login"
+    )
+    _rest_client = rest_client.SplunkRestClient(
+        None, "-", "nobody", scheme, host, port, **context
+    )
+    try:
+        response = _rest_client.http.post(
+            uri, username=username, password=password, output_mode="json"
+        )
+    except binding.HTTPError as e:
+        if e.status != 401:
+            raise
+
+        raise CredentialException("Invalid username/password.")
+
+    return json.loads(response.body.read())["sessionKey"]

solnlib/_settings.py

@@ -23,7 +23,6 @@
 import threading
 import time
 import traceback
-import warnings
 from abc import ABCMeta, abstractmethod
 from random import randint
 from typing import List, Union
@@ -40,16 +39,6 @@
 __all__ = ["ClassicEventWriter", "HECEventWriter"]
 
 
-deprecation_msg = (
-    "Function 'create_from_token' is deprecated and incompatible with 'global_settings_schema=True'. "
-    "Use 'create_from_token_with_session_key' instead."
-)
-
-
-class FunctionDeprecated(Exception):
-    pass
-
-
 class EventWriter(metaclass=ABCMeta):
     """Base class of event writer."""
 
@@ -244,13 +233,13 @@ def __init__(
             scheme, host, hec_port = utils.extract_http_scheme_host_port(hec_uri)
         else:
             if not all([scheme, host, port]):
-                scheme, host, port = get_splunkd_access_info(self._session_key)
+                scheme, host, port = get_splunkd_access_info()
             hec_port, hec_token = self._get_hec_config(
                 hec_input_name, session_key, scheme, host, port, **context
             )
 
         if global_settings_schema:
-            scheme = get_scheme_from_hec_settings(self._session_key)
+            scheme = get_scheme_from_hec_settings()
 
         if not context.get("pool_connections"):
             context["pool_connections"] = 10
@@ -283,11 +272,6 @@ def create_from_token(
             Created HECEventWriter.
         """
 
-        warnings.warn(deprecation_msg, DeprecationWarning, stacklevel=2)
-
-        if global_settings_schema:
-            raise FunctionDeprecated(deprecation_msg)
-
         return HECEventWriter(
             None,
             None,

solnlib/credentials.py

@@ -78,7 +78,7 @@ def __init__(
         """
         is_localhost = False
         if not all([scheme, host, port]) and os.environ.get("SPLUNK_HOME"):
-            scheme, host, port = get_splunkd_access_info(session_key)
+            scheme, host, port = get_splunkd_access_info()
             is_localhost = (
                 host == "localhost" or host == "127.0.0.1" or host in ("::1", "[::1]")
             )

solnlib/modular_input/event_writer.py

@@ -221,7 +221,7 @@ def __init__(
         """
         # Only do splunkd URI discovery in SPLUNK env (SPLUNK_HOME is set).
         if not all([scheme, host, port]) and os.environ.get("SPLUNK_HOME"):
-            scheme, host, port = get_splunkd_access_info(session_key)
+            scheme, host, port = get_splunkd_access_info()
         if os.environ.get("SPLUNK_HOME") is None:
             if not all([scheme, host, port]):
                 raise ValueError(