1219347 - SSL_CERT_VERIFICATION_ERRORS has a misleading description

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect)

Description

[April King [:April]]

The description for SSL_CERT_VERIFICATION_ERRORS lists the following description:

"If certificate verification failed in a TLS handshake, what was the error? (see mapping in SSLServerCertVerification.cpp)"

But the mapping is actually here:

https://dxr.mozilla.org/mozilla-central/source/security/pkix/include/pkix/Result.h#86

So it should probably read:

"If certification verification failed in a TLS handshake, what was the error? (see mapping in pkix/Result.h)"

Comment 1

[April King [:April]]

Err, I meant to say:

"If certificate verification failed in a TLS handshake, what was the error? (see mapping in pkix/Result.h)"

Comment 2

[Mark Goodwin [:mgoodwin]]

Attachment: MozReview Request: Bug 1219347 - Fix misleading description for SSL_CERT_VERIFICATION_ERRORS telemetry probe; r?keeler

Bug 1219347 - Fix misleading description for SSL_CERT_VERIFICATION_ERRORS telemetry probe; r?keeler

Comment 3

[Dana Keeler (she/her) [:keeler]]

https://reviewboard.mozilla.org/r/23663/#review21193

r=me. Just the one comment.

::: toolkit/components/telemetry/Histograms.json:8017
(Diff revision 1)
> -    "description": "If certificate verification failed in a TLS handshake, what was the error? (see mapping in SSLServerCertVerification.cpp)"
> +    "description": "If certificate verification failed in a TLS handshake, what was the error? (see mapping in security/pkix/include/pkix/Result.h)"

I have a couple of concerns about this:

1. Result.h doesn't mention SSL_CERT_VERIFICATION_ERRORS, so this might be confusing
2. MapCertErrorToProbeValue takes the values from Result.h but modifies some of them, so this comment isn't quite accurate

Maybe mentioning both files or MapCertErrorToProbeValue specifically would be best.

Comment 4

[Dana Keeler (she/her) [:keeler]]

Hmmm. I meant to check the "ship it" box, but I guess I forgot and now it won't let me...

Comment 5

[Mark Goodwin [:mgoodwin]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/c0f0bb8414411ffbf86d8837dba918060a3597ac
Bug 1219347 - Fix misleading description for SSL_CERT_VERIFICATION_ERRORS telemetry probe; r=keeler

Comment 6

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/c0f0bb841441

Comment 7

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/releases/mozilla-b2g44_v2_5/rev/c0f0bb841441