Github Mirror / telegraf-plugins: dc322167

verified

Implement support for Solis's authorization mechanism (see utilities/telegraf-plugins#9)

Implement support for Solis's authorization mechanism (see utilities/telegraf-plugins#9)

It returns the correct values for the examples given in their docs, but I'm not currently able to test this against the API: I've not been sent creds yet (in fact, my inverter's not even been installed yet)

It's a fairly simple signature mechanism, so there shouldn't be much to go wrong with it - the most likely cause of issues will be around the request body (the doc says that the hash should be empty if the body is empty, but doesn't clarify whether they mean it should be omitted, or a hash of a null string. The example in the doc has a request body).

Commit dc322167.

Authored 2023-05-13T09:53:14.000+01:00 by B Tasker in project Github Mirror / telegraf-plugins

+130 lines -0 lines

Commit Signature

Changes

diff --git a/soliscloud/soliscloud.py b/soliscloud/soliscloud.py
--- a/soliscloud/soliscloud.py
+++ b/soliscloud/soliscloud.py
# @@ -0,0 +1,130 @@
# +#!/usr/bin/env python3
# +#
# +# Telegraf exec plugin to poll the Soliscloud API and retrieve
# +# power measurement data from solar inverters
# +#
# +# Note: The soliscloud API is heavily rate limited: 3 requests per 5 seconds
# +# as a result, this plugin contains some arbitrary sleeps and needs an appropriate
# +# timeout set in Telegraf's config
# +#
# +# Copyright (c) 2023, B Tasker
# +# Released under BSD 3-Clause License
# +#
# +
# +'''
# +Copyright (c) 2023, B Tasker
# +
# +All rights reserved.
# +
# +Redistribution and use in source and binary forms, with or without modification, are
# +permitted provided that the following conditions are met:
# +
# +1. Redistributions of source code must retain the above copyright notice, this list of
# +conditions and the following disclaimer.
# +
# +2. Redistributions in binary form must reproduce the above copyright notice, this list of
# +conditions and the following disclaimer in the documentation and/or other materials
# +provided with the distribution.
# +
# +3. Neither the name of the copyright holder nor the names of its contributors may be used
# +to endorse or promote products derived from this software without specific prior written
# +permission.
# +
# +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
# +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
# +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# +COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
# +TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# +'''
# +import datetime
# +import base64
# +import hashlib
# +import hmac
# +
# +def createHMAC(signstr,secret,algo):
# + ''' Create a HMAC of signstr using secret and algo
# +
# + https://snippets.bentasker.co.uk/page-1910021144-Generate-HMACs-with-different-algorithms-Python3.html
# + '''
# + hashedver = hmac.new(secret.encode('utf-8'),signstr.encode('utf-8'),algo)
# + return hashedver.digest()
# +
# +
# +def doAuth(key_id, secret, req_path, req_body, method="POST", content_type="application/json", datestring=False):
# + ''' Calculate an authorization header value to accompany the request
# +
# + Solis' API docs describe the method as:
# +
# + Authorization = "API " + KeyId + ":" + Sign
# + Sign = base64(HmacSHA1(KeySecret,
# + VERB + "\n"
# + + Content-MD5 + "\n"
# + + Content-Type + "\n"
# + + Date + "\n"
# + + CanonicalizedResource))
# +
# +
# + Note: the API wants MD5s and SHA1s to be digests and not hexdigests
# + '''
# +
# + # Calculate an MD5 of the request body
# + # if there's no body, the hash should be empty
# + if len(req_body) > 0:
# + content_md5 = hashlib.md5(req_body.encode()).digest()
# + md5_str = base64.b64encode(content_md5).decode()
# + printDebug(f"Request body: {req_body}")
# + else:
# + md5_str = ''
# + printDebug(f"Empty Request body")
# +
# + # If there's no override, generate the current UTC date
# + # in HTTP header format
# + if not datestring:
# + printDebug(f"Calculating date")
# + d = datetime.datetime.now(tz=datetime.timezone.utc)
# + datestring = d.strftime('%a, %d %b %Y %H:%M:%S GMT')
# +
# + # Construct the string that we need to sign
# + # The entries should be seperated by \n - the API doesn't want
# + # literal newlines (presumably it evaluates them on read)
# + signstr = '\\n'.join([method,
# + md5_str,
# + content_type,
# + datestring,
# + req_path
# + ])
# +
# + printDebug(f"Signstr: {signstr}")
# +
# + # HMAC and then base64 it
# + hmacstr = createHMAC(signstr, secret, 'sha1')
# + signature = base64.b64encode(hmacstr).decode()
# +
# + # Take the values and construct the header value
# + auth_header = f"API {key_id}:{signature}"
# + printDebug(f"Calculated Auth header: {auth_header}")
# +
# + # Job done
# + return auth_header
# +
# +
# +def printDebug(msg):
# + if DEBUG:
# + print(msg)
# +
# +
# +if __name__ == "__main__":
# + DEBUG = True
# + # These are the example values used in the API doc
# + print(doAuth('2424',
# + '668018254',
# + '/v1/api/userStationList',
# + '{"pageNo":1,"pageSize":10}',
# + method="POST",
# + content_type="application/json",
# + datestring='Fri, 26 Jul 2019 06:00:46 GMT')
# + )
#