Atlassian Jira

Public/Private Key Set-up

Before any configuration of Jira or Viz can occur, public and private keys must be created if you have not done so already. The public keys will be configured into Jira. The private key will be used by Viz during REST requests.

Prerequisites: You must have openssl installed (http://www.openssl.org)

These steps should be followed if you want to set up your own:

1. Open a command prompt.
2. In the command prompt, run the following:

openssl genrsa -out jira_privatekey.pem 1024
openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
openssl x509 -pubkey -noout -in jira_publickey.cer  > jira_publickey.pem

The files generated will be in the current directory. You will need to refer to these files in the subsequent steps.

Jira Configuration Steps

The following are the steps to be followed to configure a Jira 7.0 instance:

1. Log into the Jira administration console as a user with administration rights.
2. Click on the cog icon and select the Application configuration.
3. From the Application configuration, select Application Links.
   1. This configuration may be also available under Add-Ons depending on the version of Jira that you are using.
4. In the text box that says Enter the URL of the application you want to link, enter any URL that represents Viz (e.g., https://viz.tasktop.net). This does not have to be a valid URL. It is used just for descriptive purposes.
   1.  
5. On the first screen of the Link Applications dialog, enter anything you want in the fields. The important part is you ensure the Create incoming link checkbox is checked. 
   1. 
6. Press Continue.
   1. The Incoming Authentication dialog will appear.
7. Enter the following:
   1. Consumer Key (A unique string to identify Viz. Record this value as it will be needed by Viz to send as part of REST requests)
   2. Consumer Name (A short name describing Viz)
   3. Description (optional)
   4. Public Key (the contents of the jira_publickey.pem you generated above)

      1. As an example, if the below text were the public key, you would copy/paste the abcdef12345 text into the field. You do not have to worry about stripping line wrap characters as Jira will do it for you.

         -----BEGIN PUBLIC KEY-----
         abcdef
         12345
         -----END PUBLIC KEY-----

8. Save and close.

OpenID Connect Private Key Signed JWT Authentication

Note: Jira does not support this authentication method on its own. The following plug in can be used to support this authentication method.

Required Fields

• URL for OpenID Connect credentials

  • The token endpoint. You can get this from the authentication servers well known configuration endpoint.

  • Example: https://authserver.com/adfs/oauth2/token

• OpenID Connect client ID

  • The client ID registered with the authentication server.

  • The client must have the client credentials grant type enabled.

  • The client must have registered the public certificate given in the “RSA certificate and private key (.p12)” field

• OpenID Connect scope

• Public Certificate

  • A PEM encoded public certificate of the private key being used to sign JWTs included in the requests client_assertion parameter

• RSA Private Key

  • A PEM encoded PKCS8 private key used to sign JWTs included in the requests client_assertion parameter.

Optional Fields

• Resource Parameter

  • The Open ID Connect resource parameter sent in the access token request.

  • Required for versions of Microsoft AD FS prior to 2019.

• Key ID

  • The “kid” header of the JWT sent in the access token request.

OAuth 2.0 Client Credentials Proxy Authentication (For Jira standard artifacts only) 

This authentication enables secure, token-based access via a proxy, using client credentials method.

Note: Jira does not currently support OAuth 2.0 Client Credentials authentication. As a result, the Jira connector does not allow connecting directly with the Jira repository using the OAuth 2.0 Client Credentials authentication method.