Major update of the code #1

zamothh · 2021-09-27T14:01:03Z

Desired Outcome

Simplification of the code to call functions
Storing the API key in a PsCredential object, rather than in clear text, which was very bad
Directly retrieve credential object from secrets
Centralized configuration as a single command

Implemented Changes

Changed the way Conjur is beeing configured. The API key is now stored in a PsCredential object, which is much more secured.
Simplified all the functions code, which brought more complication in the code calling the API
Added some new functions
Added some new switches
could not check anything related to AWS, as I don't have access to such implementation. All AWS code would need to be tested.

Connected Issue/Story

Resolves my own requirements

Definition of Done

Changelog

The CHANGELOG has not been updated

Test coverage

No test

Documentation

README was updated
Inline help was updated

Behavior

Mostly working as before, but with some new functions

Security

Storing API key as PsCredential Object

infamousjoeg

I've added comments in-line for all the changes requested.

I will note that while trying to test this in my lab, I was unable to Initialize Conjur using the example on the README.

After changes are made and example code on the README is fixed, I will be able to run tests on all functions and provide further review.

infamousjoeg · 2021-10-22T13:40:57Z

CyberarkConjur.psm1

+$CCConfig = @{
+	AWS_MetaData			= "169.254.169.254"
+	Account					= $null
+    AuthaurityName			= $null


Should be AuthorityName

infamousjoeg · 2021-10-22T13:41:19Z

CyberarkConjur.psm1

+	AWS_MetaData			= "169.254.169.254"
+	Account					= $null
+    AuthaurityName			= $null
+	AuthaurityName_WR		= $null


Should be AuthorityName_WR

infamousjoeg · 2021-10-22T13:41:45Z

CyberarkConjur.psm1

-    $responseBody = $null
+<#
+.SYNOPSIS
+This is the main fonction that does all the API calls.


Should be function

infamousjoeg · 2021-10-22T13:42:26Z

CyberarkConjur.psm1

-    return $responseBody;
-}
+.PARAMETER API
+[Mandatory] the main API branch you are calling


Please provide an example for further clarity.

infamousjoeg · 2021-10-22T13:43:03Z

CyberarkConjur.psm1

-    return $res
-}
+.PARAMETER FixUri
+Fixing URI issues


Please provide a better description of what is being fixed in regards to "URI issues".

infamousjoeg · 2021-10-22T15:04:39Z

README.md

 #### Conjur authentication
+Prior to launching any commands, you will need to configure your conjur environment


Capitalize conjur and end with :

infamousjoeg · 2021-10-22T15:05:54Z

README.md

-PS C:\> $env:CONJUR_AUTHN_API_KEY="adminPassword"
-PS C:\> $env:CONJUR_APPLIANCE_URL="https://conjur.yourorg.com:443"
+PS C:\> $PsCredential = Get-Credential -Message "CyberArk Conjur Credential input" -UserName "host\Host_Identifier" 
+PS C:\> Initialize-Conjur -Account Account -AuthnLogin "Identifier of a host" -Crednetial $PsCredential


Should be -Credential

Also, I used this command to test the PR code and it failed with the following error:

PS C:\Users\jgarcia\Downloads\conjur-api-powershell> Initialize-Conjur -Account "cyberarkdemo" -AuthnLogin "https://conj ur.joegarcia.dev" -Credential $PsCredential Initialize-Conjur : Parameter set cannot be resolved using the specified named parameters. At line:1 char:1 + Initialize-Conjur -Account "cyberarkdemo" -AuthnLogin "https://conjur ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidArgument: (:) [Initialize-Conjur], ParameterBindingException + FullyQualifiedErrorId : AmbiguousParameterSet,Initialize-Conjur

Until this is resolved, I cannot continue testing functions provided in this PR.

Hey there, there is some mistake here, you need to use this :
Initialize-Conjur -Account "cyberarkdemo" -AuthaurityName"conjur.joegarcia.dev" -Credential $PsCredential

Changed the readme again to bring more explenations

infamousjoeg · 2021-10-22T15:06:53Z

README.md

-PS C:\> $env:CONJUR_AUTHN_LOGIN="host/cust-portal/622703825757/ubuntu-client-conjur-identity"
-PS C:\> $env:CONJUR_IAM_AUTHN_BRANCH="authnBranchName"
-PS C:\> $env:CONJUR_APPLIANCE_URL="https://conjur.yourorg.com:443"
+PS C:\> Initialize-Conjur -Account Account -AuthnLogin "Identifier of a host" -AuthnApiKey "Your API generated key" -AuthaurityName "your-conjur-auth-read.mycompany.com" 


Should be -AuthorityName after corrections are made to CyberarkConjur.psm1

infamousjoeg · 2021-10-22T15:07:22Z

README.md

 ```

+#### IAM Authentication
+Some code has been started to be written, but is not good enough to publish anything yet.
+This would require someone with an IAM access to continue developping this code


Should be developing and end with .

infamousjoeg · 2021-10-22T15:07:52Z

README.md

+#### Initialize-Conjur
+
+```powershell
+PS C:\> Initialize-Conjur -Account Account -AuthnLogin "Identifier of a host" -AuthnApiKey "Your API generated key" -AuthaurityName "your-conjur-auth-read.mycompany.com" 


Should be -AuthorityName after changes are made to CyberarkConjur.psm1

infamousjoeg · 2022-03-09T18:23:06Z

Just a gently nudge that there are still pending requested changes in order to merge this PR. 😄

zamothh · 2022-03-11T13:01:28Z

Hello @infamousjoeg ... I might be wrong, but I really think I fixed all of your issues.
One of the error you are talking about might be this one :

Initialize-Conjur -Account "cyberarkdemo" -AuthnLogin "https://conjur.joegarcia.dev" -Credential $PsCredential

The issue does not come from the module but from how you are using the command.

Initialize-Conjur can work in 2 different ways, and you can not mix them (different parameter set)

-Credential : which is a PsCredential object (secured) containing both your login/ApiKey in username/password
-AuthnLogin and AuthnApiKey : which are both required, but comes as an not encrypted data

You can not mix -Credential and -AuthnLogin

This is also shown under the SYNTAX section of the get-help :

PS> get-help Initialize-Conjur

NAME
    Initialize-Conjur

SYNOPSIS
    This command is required prior to running any other one. This will configure the module with the required settings.


SYNTAX
    Initialize-Conjur [-Account <String>] [-Credential <PSCredential>] [-AuthorityName <String>] [-AuthorityName_WR
    <String>] [-IamAuthnBranch <String>] [-AWS_MetaData <String>] [-IgnoreSsl] [<CommonParameters>]

    Initialize-Conjur [-Account <String>] -AuthnLogin <String> -AuthnApiKey <String> [-AuthorityName <String>]
    [-AuthorityName_WR <String>] [-IamAuthnBranch <String>] [-AWS_MetaData <String>] [-IgnoreSsl] [<CommonParameters>]


DESCRIPTION
    Please check all the parameters in the help file.
    Mandatory parameters are :
    Account     : Organization account name
    Credential : Will store the API key that will grant you access to Conjur
    AuthorityName : DNS authority name of your Conjur instance


RELATED LINKS

REMARKS
    To see the examples, type: "Get-Help Initialize-Conjur -Examples"
    For more information, type: "Get-Help Initialize-Conjur -Detailed"
    For technical information, type: "Get-Help Initialize-Conjur -Full"

tfarray added 9 commits September 23, 2021 11:45

indenting alignement

2434afc

major rewrite done. Most functionalities are up

82ebc82

so many changes !!! I am not sure I can explain them all

41374f5

fixed readme.md to modify the text

1a53a81

added some functions

db5552d

fixed psd1 file

53e55c2

lots of changes, still need a few

3f01f44

fixed many things, mostly help commands

7475c7c

fixed a major issue with identifier not beeing added to URL

ddee27b

infamousjoeg self-requested a review October 22, 2021 12:31

infamousjoeg requested changes Oct 22, 2021

View reviewed changes

tfarray added 2 commits October 25, 2021 11:05

Mostly fixing typos & grammar

f1dff8c

Removes existing token when initializing Cyberark

ad12979

text modifications on help, and almost nothing else

9a305f0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Major update of the code #1

Major update of the code #1

Uh oh!

zamothh commented Sep 27, 2021

Uh oh!

infamousjoeg left a comment

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

zamothh Oct 25, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg Oct 22, 2021

Uh oh!

infamousjoeg commented Mar 9, 2022

Uh oh!

zamothh commented Mar 11, 2022 •

edited

Loading

Uh oh!

Uh oh!

		#### Conjur authentication
		Prior to launching any commands, you will need to configure your conjur environment

Major update of the code #1

Are you sure you want to change the base?

Major update of the code #1

Uh oh!

Conversation

zamothh commented Sep 27, 2021

Desired Outcome

Implemented Changes

Connected Issue/Story

Definition of Done

Changelog

Test coverage

Documentation

Behavior

Security

Uh oh!

infamousjoeg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

infamousjoeg commented Mar 9, 2022

Uh oh!

zamothh commented Mar 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

zamothh commented Mar 11, 2022 •

edited

Loading