Subscribe to PortalGuard's Quarterly Newsletter for News & Updates on the Latest Release! Click to Subscribe

Understanding PortalGuard Error Codes


Problem

PortalGuard returning errors in the logging.  The PG_log is showing major and minor error codes.

Solution


All the individual logic for request/response handling in PG are encapsulated by "agents". These agents ALWAYS return major error codes that indicate the overall success or failure of the request. Minor error codes are also returned by agents and these are more useful, in that they describe "why" an agent failed. All return codes, both "major" and "minor", can be found in Appendix B of the PortalGuard Admin Guide (link):

  • List of all PG Agents: Search for the "Agent Type Codes" table
  • List of all "Major" error codes: Search for the "Major Error Codes" table
  • List of all "Minor" error codes: Search for the "Minor Error Codes" listing

Example:

When a user is logging in and has not enrolled all self-service information an error code will be present in the log.  The log will show this when prompting for enrollment.  If an end user is using an OTP fails to enter it correctly an additional error code will be present.. Below is an example of a failed login with a snip of the log file as well.

In this case, error 25 is PGAPI_RC_OTPENTRY_FAILURE which means PG couldn't fully complete an operation of verifying a user's OTP. More important is the minor error code of 1418 which is PGAPI_RC_SELFSERV_NEED_ENROLL. Looking at the log below as an example, the 'PGUser' user wasn't allowed to complete the login to PG because they hadn't yet enrolled challenge answers ("auth 16") or their phone number ("auth 32"):

Error 1418:

Error 25:

 2018-Sep-04 10:25:58.321261 [0x00000f98] (v) AgentBase::getSSOptions(): Optional answers not set for user: 'PGUser'
2018-Sep-04 10:25:58.321261 [0x00000f98] (v) AgentBase::getSSOptions(): Phone OTP authentication is enabled
2018-Sep-04 10:25:58.321261 [0x00000f98] (d) AgentBase::handleSSEnrollment(): Reminding user of required enrollment for auth 16
2018-Sep-04 10:25:58.321261 [0x00000f98] (v) AgentBase::addErrCode(): Code: 1418
2018-Sep-04 10:25:58.321261 [0x00000f98] (d) CPSReturn::addErrCode(): Adding minor error code 1418
2018-Sep-04 10:25:58.321261 [0x00000f98] (d) AgentBase::handleSSEnrollment(): Reminding user of required enrollment for auth 32
2018-Sep-04 10:25:58.321261 [0x00000f98] (v) AgentBase::addErrCode(): Code: 1418
2018-Sep-04 10:25:58.321261 [0x00000f98] (d) AgentOTPEntry::handleRequest(): User 'PGUser' must be prompted for SS enrollment

REV. 09/2018 | PortalGuard

  • 55
  • 28-Sep-2018
  • 147 Views