allow key to be stored in a config file

Author: tboyko

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.2.0] - 2020-08-24
+
+### Added
+
+- Support for file-based API key storage
+
 ## [1.1.3] - 2020-08-18
 
 ### Added

README.md

@@ -2,11 +2,7 @@
 
 ## Requirements
 
-If you plan on using [AutoPkg](https://github.com/autopkg/autopkg), a release greater than 2.1 is required as earlier versions do not have Munki repo plugin support. Currently (8/10/20) the latest build does not include support, so the following files need to be pulled from the AutoPkg repo and replaced on your local installation:
-
-* `autopkglib/MunkiImporter.py`
-* `autopkglib/munkirepolibs/AutoPkgLib.py`
-* `autopkglib/munkirepolibs/MunkiLibAdapter.py`
+If you plan on using [AutoPkg](https://github.com/autopkg/autopkg), release 2.2 or greater is required as earlier versions do not have Munki repo plugin support.
 
 ## Installation
 
@@ -22,25 +18,56 @@ API keys may be generated within the API section of the SimpleMDM administrator
 
 #### Setting the Key
 
-The plugin will usually prompt for an API key interactively. To avoid this, you may set the key once per terminal session like so:
+The plugin attempts to fetch the API key three ways, in order:
+
+1. environment variable
+1. configuration file
+1. interactively
+
+##### Environment Variable
+
+You may set the key once per terminal session like so:
 
 ```
 export SIMPLEMDM_API_KEY="Whvop7kWXxsva326ABDF8VDCSGFyEkuEx2xGgj4jab8AE90cn70QdBTq0fplli0a" 
 ```
 
+You can also set the key for a single command by prepending it like so:
+
+```
+SIMPLEMDM_API_KEY="Whvop7kWXxsva326ABDF8VDCSGFyEkuEx2xGgj4jab8AE90cn70QdBTq0fplli0a" autopkg run ...
+```
+
+##### Configuration File
+
+You may store the key in a configuration file at `/usr/local/simplemdm/munki-plugin/config.plist`. Please scope the permissions on this file so that it is restricted, however still allowing utilities using the repo plugin to access it. 
+
+The file should be formatted as below. Be sure to provide your own API key:
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>key</key>
+  <string>Whvop7kWXxsva326ABDF8VDCSGFyEkuEx2xGgj4jab8AE90cn70QdBTq0fplli0a</string>
+</dict>
+</plist>
+```
+
 ### Using AutoPkg
 
 Any `.munki` recipe is supported. In this case, we are importing `GoogleChrome.munki`. Be sure to include `extract_icon` if you'd like the icon uploaded to SimpleMDM, if available.
 
-**Please Note:** Running MakeCatalogs.munki is not necessary. See "Do not use makecatalogs" below for more information.
+**Please Note:** Running MakeCatalogs.munki is not necessary. See "Using Makecatalogs" below for more information.
 
 ```
 autopkg run -v GoogleChrome.munki -k MUNKI_REPO_PLUGIN="SimpleMDMRepo" -k extract_icon=True
 ```
 
 ### Using munkiimport and manifestutil
 
-**Please Note:** Running makecatalogs is not necessary. See "Do not use makecatalogs" below for more information.
+**Please Note:** Running makecatalogs is not necessary. See "Using Makecatalogs" below for more information.
 
 Before using either of these tools, they must be configured by running `munkiimport --configure` or `manifestutil --configure`. Keep all settings default, except:
 - Set repo url to `BLANK` or some other dummy value, as it is unused.

SimpleMDMRepo.py

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 # SimpleMDMRepo.py
-# Version 1.1.3
+# Version 1.2.0
 
 from __future__ import absolute_import, print_function
 
@@ -20,8 +20,10 @@
     from urllib.parse import quote
 
 from munkilib.munkirepo import Repo, RepoError
+from munkilib.wrappers import readPlistFromString, PlistReadError
 
 DEFAULT_BASE_URL = 'https://a.simplemdm.com/munki/plugin'
+CONFIG_PATH      = '/usr/local/simplemdm/munki-plugin/config.plist'
 
 class SimpleMDMRepo(Repo):
 
@@ -35,11 +37,37 @@ def __init__(self, baseurl):
         print('NOTICE: The SimpleMDMRepo plugin ignores the MUNKI_REPO value. "{base_url}" will be used instead.'.format(base_url=self.base_url))
 
     def _fetch_api_key(self):
+        # fetch from environment argument
+
         if 'SIMPLEMDM_API_KEY' in os.environ:
+            print('Usig API key provided by environment variable.')
             return os.environ['SIMPLEMDM_API_KEY']
-        else:
-            print('Please provide a SimpleMDM API key')
-            return getpass.getpass()
+
+        # fetch from config file
+
+        try:
+            with open(CONFIG_PATH,'rb') as f:
+                config_str = f.read()
+        except IOError as e:
+            if e.errno != 2:
+                print('WARNING: Could not read config file: {error}'.format(error=e))
+            config_str = None
+
+        if config_str:
+            try:
+                config = readPlistFromString(config_str)
+            except PlistReadError as e:
+                print('WARNING: Could not parse config file: {error}'.format(error=e))
+            else:
+                key = config.get('key', None)
+                if key and len(key) > 0:
+                    print('Using API key provided in key file.')
+                    return key
+
+        # fetch interactively 
+
+        print('Please provide a SimpleMDM API key')
+        return getpass.getpass()
 
     def _fetch_auth_header(self):
         key          = self._fetch_api_key()