Anonymous and certificate authentication

[ritzcrackr]

Description

This Pull Request adds support for using certificate authentication and removes the need for credentials for Confluence Servers that do not require them. While this may look like a huge change, it does touch almost all the files, at its heart it is just enabling each function to pass a certificate instead of PSCredentials to Invoke-WebRequest. Invoke-WebRequest already supports certificate authentication.

I accomplished the certificate support by changing how the splatting from the outer functions to Invoke-Method and then to Invoke-WebRequest happened. Along the way I created a helper function called Copy-CommonParameter to assist in copying the appropriate $PSBoundParameters to enable better handling of parameters. I used Copy-CommonParameters anytime I needed to pass the auth parameters (i.e. $Credential or $Certificate) to an inner function call. By leveraging splatting I didn't need to know which parameter was set.

As I was updating the passing of parameters logic via splatting, I took the opportunity to simplify some logic. I didn't make any changes that added or removed features. I did take the time to fix the casing on ApiUri and [uri] to be consistent with the other parameters.

I believe the code is actually easier to read and understand after this PR as its flow is much more straightforward.

Before submitting I ran all the included tests along with porting my some of my existing scripts to work with this module.

Motivation and Context

The motivation behind this commit is that I maintain my own private PowerShell Module/Scripts for Confluence. My work was more a thin wrapper on Invoke-RestMethod without many of niceties provided by this module or PowerShell Core 6 support. Though this module has one big limitation, I need to use certificate authentication with my instance of Confluence. So instead of trying to maintain my own private module/scripts I would like to contribute to an open source Confluence PowerShell Module. This commit would enable me to replace my existing work and be a starting point for future commits.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My code follows the code style of this project.
• I have added Pester Tests that describe what my changes should do.
• I have updated the documentation accordingly.

[ritzcrackr]

@lipkau, Is there anything I can do to get this PR accepted? I would really like to use the official release of this module but my company's Atlassian setup requires Certificate Authentication.

[lipkau]

Great job!
thanks for that!

I might require your help to move this to the v3 branch, as I don't have a setup where I can test if this works.
Ar you on the slack server already?

[lipkau]

btw... this will be a nightmare to marge into my v3 branch :-(

[ritzcrackr]

I can definitely help with porting these changes to the v3 branch. I have looked a bit at the v3 branch and the feature/useAtlassianPSConfiguration in your repo but I am unsure which is the best starting point. Is your plan to merge the feature/useAtlassianPSConfiguration feature branch into the v3 or into develop? I think you are merging feature/useAtlassianPSConfiguration into v3, correct? Should I wait until you do that or just start with feature/useAtlassianPSConfiguration?

I was also interested in making these same changes to the JiraPS project. I wanted to get them accepted to the ConfluencePS project first before spending the time to make the same changes to the JiraPS project. Let me know the best way to proceed.

[lipkau]

yes. feature/useAtlassianPSConfiguration is a feature branch for release/v3.0.
I am finishing up the update of already existing functions and will merge it.

My intention is to update AtlassianPSConfiguration to have a property for the certificate in the [AtlassianPS.ServerData] class and have it be populated for a specific server with Connect-ConfluenceServer.