Initial commit

Relocated from https://github.com/cloudlinuxadmin/kernelchecker/

Author: histrio

LICENSE

@@ -0,0 +1,201 @@
+                                 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 2016 Cloud Linux Zug GmbH
+
+   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.

README.md

@@ -0,0 +1,92 @@
+#KernelChecker
+
+_kernelcheker.py_
+KernelChecker was created to allow control panels to easily detect & advise
+users on updating running kernel. It can be used to promote KernelCare
+through the control panel. One of the goals behind creating this script was to to make it easier for control
+panel providers to setup effective affiliate program with KernelCare to generate extra income.
+If you are interested in affiliate program, contact us at [email protected]
+
+
+The purpose of KernelChecker is to determine if:
+  * newer kernel is available
+  * if update / reboot is needed
+  * if KernelCare (http://kernelcare.com) is installed
+  * if latest patches are installed using KernelCare
+
+
+The script should work on dpkg & RPM based distributions. It should be able to detect if it is running inside container (Virtuozzo & LXC)
+
+By defalt it produces YAML output. Additionally it understands --json / -j command line options that causes it to produce output in JSON
+
+Usage:
+```bash
+python kernelchecker.py [--json]
+```
+
+Example output:
+```YAML
+latest : 3.13.0-79-generic
+current : 3.13.0-79-generic
+distro : dpkg
+needs_update : False
+latest_installed : True
+latest_available : True
+inside_container : False
+kernelcare :
+  installed : False
+  up2date : False
+  supported : True
+```
+
+* latest --> Latest available kernel
+* current --> current booted kernel
+* distro --> more like package manager, possible values: dpkg, rpm & unknown
+* needs_update --> newer kernel exits, reboot will be needed
+* latest_installed --> latest kernel already installed, no need to run yum update/etc...
+* inside_container --> if True, other values could be ignored, as we are running inside container and cannot update kernel
+* kernelcare : installed --> if True, KernelCare installed
+* kernelcare : up2date --> if True, kernel is patched with all the security patches, no need to update kernel (even if needs_update shows up)
+* kernelcare : supported --> if True, KernelCare supports this kernel, if False - KernelCare doesn't support this kernel
+
+Some example of usages / advising customer based on results:
+
+```
+if inside_container == True: do nothing
+// customer should not be advised to update/reboot no matter what
+// as customer doesn't have ability to do so. 
+// Also, node kernel might be patched using KernelCare or other tools.
+else if needs_update == False : customer running latest kernel, nothing needs to be done
+else if kernelcare.up2date == True: nothing needs to be done, Kernel is patched with KernelCare
+else if needs_update == False {
+  if kernelcare.installed: ask customer to run kcarectl --update
+  else if kernelcare.supported: ask customer to deploy KernelCare
+  else if latest_installed: ask customer to reboot
+  else: ask customer to update using yum update/apt-get update, and reboot_
+}
+```
+
+
+_kc-compat.py_
+Checks if server is running kernel compatible with KernelCare.
+Usage:
+```bash
+python kc-compat.py [--silent|-q]
+```
+
+Outputs COMPATIBLE if kernel supported, UNSUPPORTED and UNSUPPORTED; INSIDE CONTAINER
+if --silent flag is provided -- doesn't print anything
+Produces exit code 0 if compatible; 1 unsupported; 2 unsupported, inside container
+
+Alternatively you can use: 
+```bash
+curl -s https://raw.githubusercontent.com/iseletsk/kernelchecker/master/py/kc-compat.py|python
+```
+
+or
+```bash
+wget -qq -O - https://raw.githubusercontent.com/iseletsk/kernelchecker/master/py/kc-compat.py|python
+```
+
+_Note: You cannot use exit code in this case, only output_
+

kc-compat.py

@@ -0,0 +1,99 @@
+import struct
+import urllib2
+import sys
+import os
+
+__author__ = 'Igor Seletskiy'
+__copyright__ = "Copyright (c) Cloud Linux GmbH & Cloud Linux Software, Inc"
+__credits__ = 'Igor Seletskiy'
+__license__ = 'Apache License v2.0'
+__maintainer__ = 'Igor Seletskiy'
+__email__ = '[email protected]'
+__status__ = 'Production'
+__version__ = '1.0'
+
+
+def get_kernel_hash():
+    try:
+        # noinspection PyCompatibility
+        from hashlib import sha1
+    except ImportError:
+        from sha import sha as sha1
+    f = open('/proc/version', 'rb')
+    try:
+        return sha1(f.read()).hexdigest()
+    finally:
+        f.close()
+
+
+def inside_vz_container():
+    """
+    determines if we are inside Virtuozzo container
+    :return: True if inside container, false otherwise
+    """
+    return os.path.exists('/proc/vz/veinfo') and not os.path.exists('/proc/vz/version')
+
+
+def _get_last_byte_from(filename):
+    """ Reading the last byte from the varfile
+    :return: last byte in a file as unsigned int or None if file was empty
+    """
+    with open(filename, 'rb') as f:
+        last, = struct.unpack("B", f.read()[-1])
+        return last
+
+
+def is_secure_boot():
+    """ Detects Secure Boot
+    :return: True if Secure Boot is enabled, false otherwise
+    """
+    efivars_location = "/sys/firmware/efi/efivars/"
+    if not os.path.isdir(efivars_location):
+        return False
+    for filename in os.listdir(efivars_location):
+        if filename.startswith('SecureBoot'):
+            varfile = os.path.join(efivars_location, filename)
+            return _get_last_byte_from(varfile) == 1
+    return False
+
+
+def inside_lxc_container():
+    return '/lxc/' in open('/proc/1/cgroup').read()
+
+
+def is_compat():
+    url = 'http://patches.kernelcare.com/'+get_kernel_hash()+'/version'
+    try:
+        urllib2.urlopen(url)
+        return True
+    except:
+        return False
+
+
+def myprint(silent, message):
+    if not silent:
+        print(message)
+
+
+def main():
+    """
+    if --silent or -q argument provided, don't print anything, just use exit code
+    otherwise print results (COMPATIBLE or UNSUPPORTED)
+    else exit with 0 if COMPATIBLE, 1 or more otherwise
+    """
+    silent = len(sys.argv) > 1 and (sys.argv[1] == '--silent' or sys.argv[1] == '-q')
+    if is_secure_boot():
+        myprint(silent, "UNSUPPORTED; SECURE BOOT")
+        return 3
+    if inside_vz_container() or inside_lxc_container() or is_secure_boot():
+        myprint(silent, "UNSUPPORTED; INSIDE CONTAINER")
+        return 2
+    if is_compat():
+        myprint(silent, "COMPATIBLE")
+        return 0
+    else:
+        myprint(silent, "UNSUPPORTED")
+        return 1
+
+if __name__ == "__main__":
+    exit(main())