Installation Instructions for CSR Generator App

1. Download the App:

Ensure you have the app package in .tar.gz or .spl format, ready for installation.

Open your browser and go to the Splunk web interface (https://<your-splunk-instance>:8000).
Log in with an admin or user account with app installation privileges.

Go to Apps > Manage Apps.
Click on Install app from file.
Choose the CSR Generator package (csr_generator.spl or .tar.gz) from your local machine.
Click Upload to install the app.

After the upload, return to the Manage Apps page and confirm that the CSR Generator app is listed and enabled.

The app relies on OpenSSL for generating the private key and CSR.
OpenSSL Path: Ensure OpenSSL is available on your Splunk instance at /opt/splunk/bin/splunk cmd openssl. If it's installed in a different location, adjust the script accordingly.
You can verify OpenSSL by running:
bash /opt/splunk/bin/splunk cmd openssl version

Ensure the correct Python environment is used, especially if running on Splunk 8.x or later, which requires Python 3.
You can verify by running:
bash /opt/splunk/bin/splunk cmd python --version

Open the Search & Reporting app in Splunk.
Run the following SPL command to generate a CSR and private key:
spl | gencsr common_name="example.com" country="US" state="California" locality="San Francisco" organization="Example Corp" organizationalunit="IT" password="yourpassword" subjectaltname="www.example.com,mail.example.com"
Parameters:
- common_name: (Required) The domain name for which the certificate is generated.
- country: (Optional) Default is "US".
- state: (Optional) Default is "N/A".
- locality: (Optional) Default is "N/A".
- organization: (Optional) Default is "N/A".
- organizationalunit: (Optional) Default is "N/A".
- password: (Optional) Password for the private key. Default is "dummypassword".
- subjectaltname: (Optional) Specify multiple SANs, separated by commas (e.g., "www.example.com,mail.example.com").
The output will display:
CSR (Certificate Signing Request) as a string.
Private Key as a string.

Once the search completes, copy the CSR and private key from the search results and save them locally for further use (e.g., submitting the CSR to a certificate authority).

If OpenSSL is installed in a non-default location, modify the OpenSSL commands in the Python script (bin/gencsr.py) to reflect the correct path to openssl.
Update these lines to point to your OpenSSL installation:
python gen_key_cmd = f"/path/to/openssl genrsa -des3 -passout pass:{password} -out {key_path} 2048 -noout"

If you encounter issues, check the Splunk logs for error messages:
Navigate to Settings > Server settings > Server Logs.
Check for logs related to the csr_generator app.
Additionally, the app will provide error messages directly in the search results if OpenSSL command execution fails.

Ensure that all Python code in the app is compatible with both Python 2 and 3 if you are running Splunk 8.x or later.

Following these instructions will ensure the CSR Generator app is installed correctly and ready for use on your Splunk instance.