belkast/soapClient
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added more information and made things easier to read.

Browse Source
This commit is contained in:
Keith Armstrong 2025-01-01 16:19:43 -05:00
parent 04f9008227
commit 5286d0b577
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -61,7 +61,8 @@ I use IDEA IntelliJ Community Ediiton when writing JAVA code.
</ul>
### Configuration file
A file similar to the one shown below is all you need to get started.
This is the main file used by the program, and one similar to that shown below is all you need to get started.
```toml
SHIM_URL = https://test.mycompany.com:8443/IDMProv/role/service
@ -76,6 +77,8 @@ JAVA_KS_PASSWORD = changeit
### XML template file
This is the XML file that is sent to the SOAP service once all search and replace tokens have been processed.
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.novell.com/role/service">
<soapenv:Header/>
@ -100,6 +103,7 @@ JAVA_KS_PASSWORD = changeit
```
### Java keystore
If the SOAP service uses <b>https</b> you have one of two choices for keystore:
<ul>
<li>Use your own local keystore and specify it in the configuration file</li>
@ -108,6 +112,7 @@ If the SOAP service uses <b>https</b> you have one of two choices for keystore:
## Encrypt a password
To encrypt a password, run the <i>linux_runner.sh</i> bash script as shown below.
```zsh
@ -120,6 +125,7 @@ Decoded / Decrypted : Password123
```
## Verification of the CSV input file
To verify the CSV input file, run the <i>linux_verify.sh</i> bash script as shown below.
```zsh
@ -166,10 +172,11 @@ CSV file is valid : true
To run the program, just run the <i>linux_runner.sh</i> bash script shown at the beginning of this README.
### Getting Help
If you run the <i>linux_runner.sh</i> bash script with no command line parameters, you will receive a help screen.
```zsh
keiarm@US09MAC769Q60KJ TEST % ./linux_runner.sh
./linux_runner.sh
Usage: <main class> [options]
Options:
@ -183,16 +190,28 @@ Usage: <main class> [options]
Location of the properties file
```
### With Parameters
### With command line parameters
Please note that if the <i>--key</i> command line parameter and the <i>--encrypt</i> command line parameter are specified, the program will encrypt the passed value and exit.
Initially, the program checks for the following potential issues before sending the SOAP XML to the SOAP service:
The program checks the for the following potential issues before sending the SOAP document to the SOAP service:
<ul>
<li>The <i>--key</i> command line parameter is specified</li>
<li>The <i>--props</i> command line parameter is specified</li>
<li>The <i>--key</i> command line parameter is specified:</li>
<ul>
<li>If specified, it must have a length of 16 characters</li>
<li>If NOT specified, you will be asked to enter it</li>
</ul>
<li>The <i>--props</i> command line parameter is specified:</li>
<ul>
<li>If specified, there is a check to make sure that the file exists</li>
</ul>
<li>If configured, check that the encrypted password can be decrypted</li>
<li>The CSV input file must exist</li>
<li>The XML template file must exist</li>
</ul>
A simple example is shown below.
```zsh
./linux_runner.sh --debug true --key 420CondoCondo420 --props props_USER_TO_ROLE.conf
@ -234,4 +253,6 @@ Once the CSV file is processed, the data is sent to the SOAP service. The XML fi
</ser:assignRequest>
</ser:requestRolesAssignmentRequest>
</soapenv:Body></soapenv:Envelope>
```
```
If you require any additional assistance, or you have any enhancement requests, please get in touch by visiting the <a href="https://www.belkast.com">Belkast Consulting</a> website.