Create CLI for stx-oidc-client

Add a CLI oidc-auth to obtain token through oidc-client and dex
from Windows Active Directory for Kubernetes authentication.

Story: 2006711
Task: 38919

Change-Id: Id0e505202a926aaaf8f6e1182c8c87738ab61025
Signed-off-by: Teresa Ho <teresa.ho@windriver.com>

.gitignore

@@ -0,0 +1,2 @@
+*.egg-info
+.tox

centos_iso_image.inc

@@ -1 +1,2 @@
 stx-oidc-auth-helm
+oidcauthtools

centos_pkg_dirs

@@ -1,2 +1,3 @@
 dex-helm
 stx-oidc-auth-helm
+oidc-auth-tools

centos_stable_wheels.inc

@@ -0,0 +1 @@
+oidcauthtools-wheels

oidc-auth-tools/centos/build_srpm.data

@@ -0,0 +1,2 @@
+SRC_DIR="oidcauthtools"
+TIS_PATCH_VER=0

oidc-auth-tools/centos/oidc-auth-tools.spec

@@ -0,0 +1,72 @@
+%global pypi_name oidcauthtools
+
+Summary: OIDC authentication tool package
+Name: %{pypi_name}
+Version: 1.0
+Release: %{tis_patch_ver}%{?_tis_dist}
+License: Apache-2.0
+Group: base
+Packager: Wind River <info@windriver.com>
+URL: unknown
+BuildArch: noarch
+Source: %name-%version.tar.gz
+
+BuildRequires: python-pbr >= 2.0.0
+BuildRequires: python-setuptools
+BuildRequires: python2-wheel
+
+Requires: python2-mechanize
+Requires: python-pbr >= 2.0.0
+
+
+%description
+This package contains OIDC authentication tools to obtain token
+from DEX and setup kubernetes credential for a user.
+
+%define local_bindir /usr/bin/
+%define pythonroot /usr/lib/python2.7/site-packages
+
+
+%prep
+%setup
+
+# Remove bundled egg-info
+rm -rf *.egg-info
+
+%build
+export PBR_VERSION=%{version}
+%{__python2} setup.py build
+%py2_build_wheel
+
+%install
+export PBR_VERSION=%{version}
+%{__python} setup.py install --root=$RPM_BUILD_ROOT \
+                             --install-lib=%{pythonroot} \
+                             --prefix=/usr \
+                             --install-data=/usr/share \
+                             --single-version-externally-managed
+mkdir -p $RPM_BUILD_ROOT/wheels
+install -m 644 dist/*.whl $RPM_BUILD_ROOT/wheels/
+
+%global _buildsubdir %{_builddir}/%{name}-%{version}
+install -d 755 %{buildroot}%{local_bindir}
+
+%clean
+rm -rf $RPM_BUILD_ROOT
+
+%files
+%license LICENSE
+%defattr(-,root,root,-)
+/usr/bin/*
+%{python2_sitelib}/oidcauthtools
+%{python2_sitelib}/*.egg-info
+
+
+%package wheels
+Summary: %{name} wheels
+
+%description wheels
+Contains python wheels for %{name}
+
+%files wheels
+/wheels/*

oidc-auth-tools/oidcauthtools/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

oidc-auth-tools/oidcauthtools/oidcauthtools/__init__.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2020 Wind River Systems, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+#

oidc-auth-tools/oidcauthtools/oidcauthtools/oidc_auth.py

@@ -0,0 +1,118 @@
+#
+# Copyright (c) 2020 Wind River Systems, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+#!/usr/bin/env python
+
+import getopt, sys
+import getpass
+from argparse import ArgumentParser
+import mechanize
+import ssl
+
+def main():
+
+    parser = ArgumentParser(description="OIDC authentication")
+
+    parser.add_argument("-c", "--client", dest="client",
+                        help="OIDC client IP address",
+                        required=True)
+    parser.add_argument("-u", "--username", dest="username",
+                        help="Username",
+                        required=True)
+    parser.add_argument("-p", "--password", dest="password",
+                        help="Password")
+
+    parser.add_argument("-v", "--verbose", action='count')
+    args = parser.parse_args()
+
+    verbose = args.verbose
+    username = args.username
+    password = args.password
+    client = args.client
+
+    if not password:
+        try:
+            password = getpass.getpass()
+        except Exception as error:
+            print('ERROR', error)
+
+    dexClientUrl = "https://" + client + ":30555"
+    if verbose:
+        print ("client: " + dexClientUrl)
+        print ("username: " + username)
+        print ("password: " + password)
+
+    ssl._create_default_https_context = ssl._create_unverified_context
+    br = mechanize.Browser()
+    br.set_handle_robots(False)
+    br.addheaders = [("User-agent","Mozilla/5.0")]
+
+    # Open browser on dexClientUrl
+    dexLoginPage = br.open(dexClientUrl)
+
+    # NOW ON DEX LOGIN PAGE
+    if verbose:
+        print("\ndexLoginPage:")
+        print("--------------")
+        print(dexLoginPage.read())
+
+        print("\ndexLoginPage FORMS:")
+        print("-----------------")
+        for form in br.forms():
+            print("Form name: ", form.name)
+            print(form)
+
+        print("\ndexLoginPage FORM CONTROLS:")
+        print("--------------------------")
+
+    br.form = list(br.forms())[0]
+
+    if verbose:
+        for control in br.form.controls:
+            print("Control name / type: ", control.name, " / ", control.type)
+            print(control)
+
+    br["login"] = username
+    br["password"] = password
+
+    if verbose:
+        print("\ndexLoginPage SUBMITTING FORM --> ...")
+    dexLoginGrantAccessResponse = br.submit()
+
+    # grant access final response
+    if verbose:
+        print("\ndexLoginGrantAccessResponse:")
+        print("------------------")
+
+    stringResponse = dexLoginGrantAccessResponse.read()
+    if verbose:
+        print(stringResponse)
+
+    idTokenLine = ""
+    for item in stringResponse.split("\n"):
+        if 'ID Token' in item:
+            idTokenLine = item.strip()
+
+    if not idTokenLine:
+        print("Login failed.")
+        sys.exit(1)
+
+    idToken = ""
+    import xml.etree.ElementTree as ET
+    tree = ET.fromstring(idTokenLine)
+    for node in tree.iter('code'):
+        print("Login succeeded.")
+        idToken = node.text
+
+    print("Updating kubectl config ...")
+    updateCredsCmd = "kubectl config set-credentials " + username + " --token " + idToken
+
+    import os
+    result = os.system(updateCredsCmd)
+
+
+if __name__ == "__main__":
+    ret = main()
+    sys.exit(ret)

oidc-auth-tools/oidcauthtools/setup.cfg

@@ -0,0 +1,35 @@
+[metadata]
+license_files = LICENSE
+name = oidcauthtools
+classifier =
+    Environment :: OpenStack
+    Intended Audience :: Information Technology
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: Apache Software License
+    Operating System :: POSIX :: Linux
+    Programming Language :: Python
+    Programming Language :: Python :: 2
+    Programming Language :: Python :: 2.7
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.6
+
+[global]
+setup-hooks =
+    pbr.hooks.setup_hook
+
+[files]
+packages =
+    oidcauthtools
+install_requires =
+    mechanize
+
+[entry_points]
+console_scripts =
+    oidc-auth=oidcauthtools.oidc_auth:main
+
+[nosetests]
+cover-erase = true
+verbosity = 2
+
+[wheel]
+universal = 1

oidc-auth-tools/oidcauthtools/setup.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2020 Wind River Systems, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+import setuptools
+
+setuptools.setup(
+    install_requires=['python2-mechanize'],
+    setup_requires=['pbr>=2.0.0'],
+    pbr=True
+)