Add keys to the OpenAI settings.

Relate #13, #14.

Author: WhatTheFuzz

__init__.py

@@ -1,6 +1,10 @@
 from binaryninja import PluginCommand
+from . src.settings import OpenAISettings
 from . src.entry import check_function
 
+# Register the settings group in Binary Ninja to store the API key and model.
+OpenAISettings()
+
 PluginCommand.register_for_high_level_il_function("OpenAI\What Does this Function Do (HLIL)?",
                             "Checks OpenAI to see what this HLIL function does." \
                             "Requires an internet connection and an API key "

src/exceptions.py

@@ -2,3 +2,9 @@
 
 class InvalidEngineException(OpenAIError):
     pass
+
+class RegisterSettingsGroupException(Exception):
+    pass
+
+class RegisterSettingsKeyException(Exception):
+    pass

src/settings.py

@@ -0,0 +1,49 @@
+import json
+from binaryninja.settings import Settings
+from . exceptions import RegisterSettingsGroupException, \
+                         RegisterSettingsKeyException
+
+class OpenAISettings(Settings):
+
+    def __init__(self) -> None:
+        # Initialize the settings with the default instance ID.
+        super().__init__(instance_id='default')
+        # Register the OpenAI group.
+        if not self.register_group('openai', 'OpenAI'):
+            raise RegisterSettingsGroupException('Failed to register OpenAI '
+                                                 'settings group.')
+        # Register the setting for the API key.
+        if not self.register_api_key_settings():
+            raise RegisterSettingsKeyException('Failed to register OpenAI API '
+                                               'key settings.')
+
+        # Register the setting for the model used to query.
+        if not self.register_model_settings():
+            raise RegisterSettingsKeyException('Failed to register OpenAI '
+                                               'model settings.')
+
+    def register_api_key_settings(self) -> bool:
+        '''Register the OpenAI API key settings in Binary Ninja.'''
+        # Set the attributes of the settings. Refer to:
+        # https://api.binary.ninja/binaryninja.settings-module.html
+        properties = {
+            'title': 'OpenAI API Key',
+            'type': 'string',
+            'description': 'The user\'s OpenAI API key used to make requests '
+            'the server.'
+        }
+        return self.register_setting('openai.api_key', json.dumps(properties))
+
+    def register_model_settings(self) -> bool:
+        '''Register the OpenAI model settings in Binary Ninja.
+        Defaults to text-davinci-003.
+        '''
+        # Set the attributes of the settings. Refer to:
+        # https://api.binary.ninja/binaryninja.settings-module.html
+        properties = {
+            'title': 'OpenAI Model',
+            'type': 'string',
+            'description': 'The OpenAI model used to generate the response.',
+            'default': 'text-davinci-003'
+        }
+        return self.register_setting('openai.model', json.dumps(properties))