Infoblox::OCSP::Responder - an OCSP authentication responder.


NAME

Infoblox::OCSP::Responder - an OCSP authentication responder.


DESCRIPTION

An Infoblox::OCSP::Responder object represents an OCSP authentication responder.


CONSTRUCTOR

 my $responder = Infoblox::OCSP::Responder->new(
      address      => $string,               # Required
      certificate  => $string,               # Required
      port         => $uint,                 # Optional / Default value is 80
      comment      => $string,               # Optional
      disabled     => "true" | "false",      # Optional / Default value is "false"
 );


MODULE METHODS

The following functions can be applied to an OCSP authentication responder object.

Infoblox::Grid::Admin::CertificateAuthService->ocsp_responders( )

Use this function to add or retrieve the OCSP authentication responder object in the Certificate Authentication Service object. See Infoblox::Grid::Admin::CertificateAuthService->ocsp_responders() for parameters and return values.

Example
 #Get ocsp_responders
 my $responder_list = $auth_service->ocsp_responders();
 #Modify ocsp_responders
 my $responder1 = Infoblox::OCSP::Responder->new(
      fqdn_or_ip  => 'domain.com',
      certificate => '/tmp/cert1.pem',
 );
 my $responder2 = Infoblox::OCSP::Responder->new(
      fqdn_or_ip  => '192.168.1.10',
      certificate => '/tmp/cert2.pem',
 );
 $auth_service->ocsp_responders([$responder1, $responder2]);


METHODS

This section describes all the methods that can be used to configure and retrieve the attribute values of an Infoblox::OCSP::Responder object.

certificate( )

Use this method to set the OCSP responder certificate. This attribute is write-only and cannot be retrieved.

Parameter

String with a reference to a file.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

Example
 #Set certificate
 $responder->certificate('/tmp/cer.pem');

comment( )

Use this method to set or retrieve a descriptive comment.

Parameter

Desired comment in string format with a maximum of 256 bytes.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example
 #Get comment
 my $comment = $responder->comment();
 #Modify comment
 $responder->comment("Modified comment");

disabled( )

Use this method to set or retrieve the disabled flag for the OCSP authentication responder.

Parameter

Specify "true" to disable the OCSP authentication respondert or "false" to enable it. Default value is "false".

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value as "true" or "false".

Example
 #Get disabled flag
 my $disabled = $responder->disabled();
 #Modify disabled flag
 $responder->disabled("true");

address( )

Use this method to set or retrieve the IP address or the domain name for the OCSP authentication responder.

Parameter

String with the IP address or the domain name for the OCSP authentication responder.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example
 #Get address
 my $address = $responder->address();
 #Modify address
 $responder->address("192.168.1.2");

port( )

Use this method to set or retrieve the TCP Port on which the OCSP client communicates with the OCSP responder.

Parameter

An unsigned integer. Default value is 80.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example
 #Get port
 my $port = $responder->port();
 #Modify port
 $responder->port(90);


AUTHOR

Infoblox Inc. http://www.infoblox.com/


SEE ALSO

Infoblox::Grid::Admin::CertificateAuthService


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.