Package com.qualys.plugins.containerSecurity.common.QualysClient

Class QualysCSClient

java.lang.Object

com.qualys.plugins.containerSecurity.common.QualysClient.QualysCSClient

public class QualysCSClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected PrintStream	stream
protected int	timeout

Constructor Summary

Constructors

Constructor	Description
QualysCSClient(QualysAuth auth)
QualysCSClient(QualysAuth auth, PrintStream stream)

Method Summary

Modifier and Type	Method	Description
URL	getAbsoluteUrl(String path)
protected String	getAuthEndpoint(Map<String,String> apiMap)
protected byte[]	getAuthEntity()
protected Map<String,String>	getAuthHeaders()
String	getAuthTypeLabel()	Human readable auth type used for logging.
protected String	getAuthUrl(Map<String,String> apiMap)	Resolves the full URL used for token generation.
protected byte[]	getBasicAuthJWTEncodedEntity()
String	getGatewayBaseUrl()	Gateway base URL used for all Qualys API calls (same base as used by OAUTH).
protected org.apache.http.impl.client.CloseableHttpClient	getHttpClient()
QualysCSResponse	getImageDetails(String imageSha)
QualysCSResponse	getImages(String imageSha, long nowMinusSeconds)
protected byte[]	getOidcFormEncodedEntity()	Builds the client_credentials form body for the IDP (OIDC) token request.
protected boolean	isOidcAuth()
void	setBuildContext(boolean buildContext)
void	setTimeout(int timeout)	This method use to set connection timeout for http client.
QualysCSTestConnectionResponse	testConnection()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

stream

protected PrintStream stream

timeout

protected int timeout

Constructor Details

QualysCSClient

public QualysCSClient(QualysAuth auth)

QualysCSClient

public QualysCSClient(QualysAuth auth,
 PrintStream stream)

Method Details

setBuildContext

public void setBuildContext(boolean buildContext)

getImageDetails

public QualysCSResponse getImageDetails(String imageSha)

getImages

public QualysCSResponse getImages(String imageSha,
 long nowMinusSeconds)
                           throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

testConnection

public QualysCSTestConnectionResponse testConnection()

getAbsoluteUrl

public URL getAbsoluteUrl(String path)
                   throws MalformedURLException

Throws:

MalformedURLException

getGatewayBaseUrl

public String getGatewayBaseUrl()

Gateway base URL used for all Qualys API calls (same base as used by OAUTH).

isOidcAuth

protected boolean isOidcAuth()

getAuthTypeLabel

public String getAuthTypeLabel()

Human readable auth type used for logging. OIDC is surfaced as IDP.

getAuthHeaders

protected Map<String,String> getAuthHeaders()
                                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getAuthUrl

protected String getAuthUrl(Map<String,String> apiMap)
                     throws MalformedURLException

Resolves the full URL used for token generation. BASIC/OAUTH use the Qualys gateway auth endpoints; IDP (OIDC) uses the external token URL.

Throws:

MalformedURLException

getAuthEndpoint

protected String getAuthEndpoint(Map<String,String> apiMap)

getAuthEntity

protected byte[] getAuthEntity()
                        throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getOidcFormEncodedEntity

protected byte[] getOidcFormEncodedEntity()
                                   throws UnsupportedEncodingException

Builds the client_credentials form body for the IDP (OIDC) token request.

Throws:

UnsupportedEncodingException

getBasicAuthJWTEncodedEntity

protected byte[] getBasicAuthJWTEncodedEntity()
                                       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getHttpClient

protected org.apache.http.impl.client.CloseableHttpClient getHttpClient()

setTimeout

public void setTimeout(int timeout)

This method use to set connection timeout for http client.

Parameters:

timeout - - int - in secs