2024 Jamf API Updates and New Features

.codacy.yml

@@ -1,6 +1,5 @@
 ---
 exclude_paths:
   - 'aiojss/**'
-  - 'tools/**'
   - 'scripts/**'
   - 'extension_attributes/**'

.gitignore

@@ -11,3 +11,6 @@ extension_attributes/*
 !extension_attributes/Last User/
 scripts/*
 !scripts/Install Software Updates/
+!scripts/templates
+!extension_attributes/templates
+tools/ci_tests/computers.json

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-*   Using welcoming and inclusive language
-*   Being respectful of differing viewpoints and experiences
-*   Gracefully accepting constructive criticism
-*   Focusing on what is best for the community
-*   Showing empathy towards other community members
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-*   The use of sexualized language or imagery and unwelcome sexual attention or advances
-*   Trolling, insulting/derogatory comments, and personal or political attacks
-*   Public or private harassment
-*   Publishing others' private information, such as a physical or electronic address, without explicit permission
-*   Other conduct which could reasonably be considered inappropriate in a professional setting
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

README.md

@@ -1,41 +1,41 @@
 # git2jss
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d9d618c32e93436ea67102fd3d3f5b21)](https://www.codacy.com/app/adam-furbee/git2jss?utm_source=github.com&utm_medium=referral&utm_content=BadStreff/git2jss&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c49c0bd6a88d4f1e8c6808455171178e)](https://app.codacy.com/gh/rustymyers/git2jss/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 
 A fast asynchronous python library for syncing your scripts in git with your JSS easily. This allows admins to keep their script in a version control system for easy updating rather than googling and copy-pasting from resources that they find online.
 
 ## Getting Started
-1.  Fork the Project
-2.  Install [Python version 3.6](https://www.python.org/downloads/) or higher. (this is because of the async requirements)
-3.  Run `python3.6 -m pip install -r requirements.txt` to install required modules
-4.  Run `./tools/download.py --url https://your.jss.url:8443 --username api_user` to download all scripts and extension attributes to the repository
-5.  Run `./sync.py --url https://your.jss.url:8443 --username api_user` to sync all scripts back to your JSS
+1. Fork the Project
+2. Install [Python version 3.6](https://www.python.org/downloads/) or higher. (this is because of the async requirements)
+3. Run `python3.6 -m pip install -r requirements.txt` to install required modules
+4. Run `./tools/download.py --url https://your.jss.url:8443 --username api_user` to download all scripts and extension attributes to the repository
+5. Run `./sync.py --url https://your.jss.url:8443 --username api_user` to sync all scripts back to your JSS
 
 Optional flags for `download.py`:
 
--   `--password` for CI/CD (Will prompt for password if not set)
--   `--do_not_verify_ssl` to skip ssl verification
--   `--overwrite` to overwrite all scripts and extension attributes
+- `--password` for CI/CD (Will prompt for password if not set)
+- `--do_not_verify_ssl` to skip ssl verification
+- `--overwrite` to overwrite all scripts and extension attributes
 
 Optional flags for `sync.py`:
 
--   `--password` for CI/CD (Will prompt for password if not set)
--   `--do_not_verify_ssl` to skip ssl verification
--   `--overwrite` to overwrite all scripts and extension attributes
--   `--limit` to limit max connections (default=25)
--   `--timeout` to limit max connections (default=60)
--   `--verbose` to add additional logging
--   `--update_all` to upload all resources in `./extension_attributes` and `./scripts`
--   `--jenkins` to write a Jenkins file:`jenkins.properties` with `$scripts` and `$eas` and compare `$GIT_PREVIOUS_COMMIT` with `$GIT_COMMIT`
-
-### [ConfigParser](https://docs.python.org/3/library/configparser.html) (Optional):
-
-A config file can be created in the project root or the users home folder. When a config file exists, the script will not promt for a password.
-
- A jamfapi.cfg file can provide the following variables:
-
- - username
- - password
- - url
+- `--password` for CI/CD (Will prompt for password if not set)
+- `--do_not_verify_ssl` to skip ssl verification
+- `--overwrite` to overwrite all scripts and extension attributes
+- `--limit` to limit max connections (default=25)
+- `--timeout` to limit max connections (default=60)
+- `--verbose` to add additional logging
+- `--update_all` to upload all resources in `./extension_attributes` and `./scripts`
+- `--jenkins` to write a Jenkins file:`jenkins.properties` with `$scripts` and `$eas` and compare `$GIT_PREVIOUS_COMMIT` with `$GIT_COMMIT`
+
+### [ConfigParser](https://docs.python.org/3/library/configparser.html) (Optional):
+
+A config file can be created in the project root or the users home folder. When a config file exists, the script will not promt for a password.
+
+ A jamfapi.cfg file can provide the following variables:
+
+- username
+- password
+- url
 
 ### Prerequisites
 git2jss requires [Python 3.6](https://www.python.org/downloads/) and the python modules listed in `requirements.txt`

extension_attributes/templates/Last User/ea.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+lastUser=`defaults read /Library/Preferences/com.apple.loginwindow lastUserName`
+
+if [ $lastUser == "" ]; then
+	echo "<result>No logins</result>"
+else
+	echo "<result>$lastUser</result>"

extension_attributes/templates/Last User/ea.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" ?>
+<computer_extension_attribute>
+   <name>Last User</name>
+   <enabled>true</enabled>
+   <description>This attribute displays the last user to log in.  This attribute applies to both Mac and Windows.</description>
+   <data_type>String</data_type>
+   <input_type>
+      <type>script</type>
+      <platform>Mac</platform>
+      <script/>
+   </input_type>
+   <inventory_display>General</inventory_display>
+</computer_extension_attribute>

requirements.txt

@@ -3,4 +3,5 @@ cchardet
 aiodns
 uvloop
 requests
-configparser
+configparser
+defusedxml

scripts/templates/Install Software Updates/script.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# Install all software updates
+# Example for git2jss
+
+softwareupdate -i -a
+
+exit 0

scripts/templates/Install Software Updates/script.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" ?>
+<script>
+   <name>Install Software Updates</name>
+   <category>No category assigned</category>
+   <info/>
+   <notes>Created by Brad Schmidt</notes>
+   <priority>Before</priority>
+   <parameters/>
+   <os_requirements/>
+   <script_contents/>
+</script>

sync.py

@@ -4,7 +4,6 @@
 import os
 from os.path import dirname, join, realpath
 import sys
-import xml.etree.ElementTree as ET
 import getpass
 import argparse
 import logging
@@ -14,8 +13,7 @@
 import uvloop
 import configparser
 import requests
-import configparser
-import requests
+from defusedxml import ElementTree as eTree
 
 logging.basicConfig(
     level=logging.DEBUG,
@@ -40,7 +38,7 @@ def get_uapi_token():
     fetches api token
     """
     jamf_test_url = url + "/api/v1/auth/token"
-    response = requests.post(url=jamf_test_url, auth=(username, password))
+    response = requests.post(url=jamf_test_url, auth=(username, password), timeout=5)
     response_json = response.json()
     return response_json["token"]
 
@@ -51,27 +49,7 @@ def invalidate_uapi_token(uapi_token):
     """
     jamf_test_url = url + "/api/v1/auth/invalidate-token"
     headers = {"Accept": "*/*", "Authorization": "Bearer " + uapi_token}
-    _ = requests.post(url=jamf_test_url, headers=headers)
-
-
-# https://github.com/lazymutt/Jamf-Pro-API-Sampler/blob/5f8efa92911271248f527e70bd682db79bc600f2/jamf_duplicate_detection.py#L99
-def get_uapi_token():
-    """
-    fetches api token
-    """
-    jamf_test_url = url + "/api/v1/auth/token"
-    response = requests.post(url=jamf_test_url, auth=(username, password))
-    response_json = response.json()
-    return response_json["token"]
-
-
-def invalidate_uapi_token(uapi_token):
-    """
-    invalidates api token
-    """
-    jamf_test_url = url + "/api/v1/auth/invalidate-token"
-    headers = {"Accept": "*/*", "Authorization": "Bearer " + uapi_token}
-    _ = requests.post(url=jamf_test_url, headers=headers)
+    _ = requests.post(url=jamf_test_url, headers=headers, timeout=5)
 
 
 def check_for_changes():
@@ -208,7 +186,7 @@ async def upload_extension_attribute(session, url, user, passwd, ext_attr, semap
                 if has_script and data:
                     template.find("input_type/script").text = data
                 if args.verbose:
-                    print(ET.tostring(template))
+                    print(eTree.tostring(template))
                     print("response status initial get: ", resp.status)
                 if resp.status == 200:
                     put_url = (
@@ -217,12 +195,12 @@ async def upload_extension_attribute(session, url, user, passwd, ext_attr, semap
                         + template.find("name").text
                     )
                     resp = await session.put(
-                        put_url, data=ET.tostring(template), headers=headers
+                        put_url, data=eTree.tostring(template), headers=headers
                     )
                 else:
                     post_url = url + "/JSSResource/computerextensionattributes/id/0"
                     resp = await session.post(
-                        post_url, data=ET.tostring(template), headers=headers
+                        post_url, data=eTree.tostring(template), headers=headers
                     )
     if args.verbose:
         print("response status: ", resp.status)
@@ -248,7 +226,7 @@ async def get_ea_template(session, url, user, passwd, ext_attr):
         with open(
             join(sync_path, "extension_attributes", ext_attr, xml_file[0]), "r"
         ) as file:
-            template = ET.fromstring(file.read())
+            template = eTree.parse(file.read())
     except IndexError:
         with async_timeout.timeout(args.timeout):
             headers = {
@@ -268,23 +246,25 @@ async def get_ea_template(session, url, user, passwd, ext_attr):
                         + ext_attr,
                         headers=headers,
                     ) as response:
-                        template = ET.fromstring(await response.text())
+                        template = eTree.fromstring(await response.text())
                 else:
-                    template = ET.parse(join(sync_path, "templates/ea.xml")).getroot()
+                    template = eTree.parse(
+                        join(sync_path, "templates/ea.xml")
+                    ).getroot()
     # name is mandatory, so we use the foldername if nothing is set in
     # a template
     if args.verbose:
-        print(ET.tostring(template))
+        print(eTree.tostring(template))
     if template.find("category") and template.find("category").text not in CATEGORIES:
-        ET.SubElement(template, "category").text = "None"
+        eTree.SubElement(template, "category").text = "None"
         if args.verbose:
             c = template.find("category").text
             print(
                 f"""WARNING: Unable to find category {c} in the JSS,
                   setting to None"""
             )
     if template.find("name") is None:
-        ET.SubElement(template, "name").text = ext_attr
+        eTree.SubElement(template, "name").text = ext_attr
     elif not template.find("name").text or template.find("name").text is None:
         template.find("name").text = ext_attr
     return template
@@ -344,12 +324,12 @@ async def upload_script(session, url, user, passwd, script, semaphore):
                         url + "/JSSResource/scripts/name/" + template.find("name").text
                     )
                     resp = await session.put(
-                        put_url, data=ET.tostring(template), headers=headers
+                        put_url, data=eTree.tostring(template), headers=headers
                     )
                 else:
                     post_url = url + "/JSSResource/scripts/id/0"
                     resp = await session.post(
-                        post_url, data=ET.tostring(template), headers=headers
+                        post_url, data=eTree.tostring(template), headers=headers
                     )
     if resp.status in (201, 200):
         print("Uploaded script: %s" % template.find("name").text)
@@ -369,7 +349,7 @@ async def get_script_template(session, url, user, passwd, script):
     ]
     try:
         with open(join(sync_path, "scripts", script, xml_file[0]), "r") as file:
-            template = ET.fromstring(file.read())
+            template = eTree.fromstring(file.read())
     except IndexError:
         with async_timeout.timeout(args.timeout):
             headers = {
@@ -384,14 +364,14 @@ async def get_script_template(session, url, user, passwd, script):
                     async with session.get(
                         url + "/JSSResource/scripts/name/" + script, headers=headers
                     ) as response:
-                        template = ET.fromstring(await response.text())
+                        template = eTree.fromstring(await response.text())
                 else:
-                    template = ET.parse(
+                    template = eTree.parse(
                         join(sync_path, "templates/script.xml")
                     ).getroot()
     # name is mandatory, so we use the filename if nothing is set in a template
     if args.verbose:
-        print(ET.tostring(template))
+        print(eTree.tostring(template))
     if (
         template.find("category") is not None
         and template.find("category").text not in CATEGORIES
@@ -404,7 +384,7 @@ async def get_script_template(session, url, user, passwd, script):
                     setting to None"""
             )
     if template.find("name") is None:
-        ET.SubElement(template, "name").text = script
+        eTree.SubElement(template, "name").text = script
     elif not template.find("name").text or template.find("name").text is None:
         template.find("name").text = script
     return template
@@ -427,7 +407,7 @@ async def get_existing_categories(session, url, user, passwd, semaphore):
                         c.find("name").text
                         for c in [
                             e
-                            for e in ET.fromstring(await resp.text()).findall(
+                            for e in eTree.fromstring(await resp.text()).findall(
                                 "category"
                             )
                         ]
@@ -490,26 +470,23 @@ async def main():
             CONFIG_FILE = config_path
 
     if CONFIG_FILE != "":
-        try:
-            # Get config
-            CONFPARSER.read(CONFIG_FILE)
-        except:
-            print("Can't read config file")
+        # Get config
+        CONFPARSER.read(CONFIG_FILE)
         try:
             username = CONFPARSER.get("jss", "username")
-        except:
+        except configparser.NoOptionError:
             print("Can't find username in configfile")
         try:
             password = CONFPARSER.get("jss", "password")
-        except:
+        except configparser.NoOptionError:
             print("Can't find password in configfile")
         try:
             url = CONFPARSER.get("jss", "server")
-        except:
+        except configparser.NoOptionError:
             print("Can't find url in configfile")
         try:
             sync_path = CONFPARSER.get("jss", "sync_path")
-        except:
+        except configparser.NoOptionError:
             print("Can't find sync_path in config")
 
     # Ask for password if not supplied via command line args
@@ -537,3 +514,6 @@ async def main():
         warnings.simplefilter("always", ResourceWarning)
 
     loop.run_until_complete(main())
+
+    # Remove token
+    invalidate_uapi_token(token)