Summary

Handle CertificateVerificationError throughout most of the codebase.

Review Request #13265 — Created Sept. 6, 2023 and submitted Sept. 8, 2023, 4:07 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This updates most of our certificate-related error handlers to catch

CertificateVerificationError and to return information on the

certificate.
Most of this is in the API. We're re-using the UNVERIFIED_HOST_CERT

for the response. Previously, in most cases, SSL errors were treated as

generic SCMErrors, so this will be a change for callers, but is not

considered an API breakage.
There are other places in the codebase that still need to handle this

error, and will be updated as more of the SSL cert code is completed.

Testing Done

All unit tests pass.

Commits

Summary	ID
Handle CertificateVerificationError throughout most of the codebase. This updates most of our certificate-related error handlers to catch `CertificateVerificationError` and to return information on the certificate. Most of this is in the API. We're re-using the `UNVERIFIED_HOST_CERT` for the response. Previously, in most cases, SSL errors were treated as generic `SCMError`s, so this will be a change for callers, but is not considered an API breakage. There are other places in the codebase that still need to handle this error, and will be updated as more of the SSL cert code is completed.	9977d2b9edb6acab9cc7d926bcdb0757b95da966

Summary

Handle CertificateVerificationError throughout most of the codebase.

This updates most of our certificate-related error handlers to catch `CertificateVerificationError` and to return information on the certificate. Most of this is in the API. We're re-using the `UNVERIFIED_HOST_CERT` for the response. Previously, in most cases, SSL errors were treated as generic `SCMError`s, so this will be a change for callers, but is not considered an API breakage. There are other places in the codebase that still need to handle this error, and will be updated as more of the SSL cert code is completed.

9977d2b9edb6acab9cc7d926bcdb0757b95da966

Issues

Description	From	Last Updated
'typing.Any' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:21 p.m.
'typing.Callable' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:21 p.m.
'typing.Dict' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:21 p.m.
'typing.Literal' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:21 p.m.
'kgb' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:21 p.m.
'reviewboard.certs.errors.CertificateVerificationError' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:21 p.m.
'reviewboard.certs.errors.CertificateVerificationFailureCode' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:21 p.m.
'reviewboard.webapi.errors.BACKEND_INVALID_SSL_CERT' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 6, 2023, 8:22 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/webapi/tests/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Any' imported but unused

Column: 1
Error code: F401
```
reviewboard/webapi/tests/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Callable' imported but unused

Column: 1
Error code: F401
```
reviewboard/webapi/tests/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Dict' imported but unused

Column: 1
Error code: F401
```
reviewboard/webapi/tests/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Literal' imported but unused

Column: 1
Error code: F401
```
reviewboard/webapi/tests/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'kgb' imported but unused

Column: 1
Error code: F401
```

reviewboard/webapi/tests/base.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.certs.errors.CertificateVerificationError' imported but unused

Column: 1
Error code: F401

reviewboard/webapi/tests/base.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.certs.errors.CertificateVerificationFailureCode' imported but unused

Column: 1
Error code: F401

reviewboard/webapi/tests/base.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.webapi.errors.BACKEND_INVALID_SSL_CERT' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Handle CertificateVerificationError throughout most of the codebase. This updates most of our certificate-related error handlers to catch `CertificateVerificationError` and to return information on the certificate. Most of this is in the API. We're re-using the `UNVERIFIED_HOST_CERT` for the response. Previously, in most cases, SSL errors were treated as generic `SCMError`s, so this will be a change for callers, but is not considered an API breakage. There are other places in the codebase that still need to handle this error, and will be updated as more of the SSL cert code is completed.	cca3209fb0e5c39763532c8095e423e417fda75f
	Handle CertificateVerificationError throughout most of the codebase. This updates most of our certificate-related error handlers to catch `CertificateVerificationError` and to return information on the certificate. Most of this is in the API. We're re-using the `UNVERIFIED_HOST_CERT` for the response. Previously, in most cases, SSL errors were treated as generic `SCMError`s, so this will be a change for callers, but is not considered an API breakage. There are other places in the codebase that still need to handle this error, and will be updated as more of the SSL cert code is completed.	9977d2b9edb6acab9cc7d926bcdb0757b95da966

Diff:

Revision 2 (+578 -170)

Show changes

	reviewboard/scmtools/forms.py
	reviewboard/webapi/resources/repository_branches.py
	reviewboard/webapi/resources/repository_commits.py
	reviewboard/webapi/resources/review_request.py
	reviewboard/webapi/resources/review_request_draft.py
	reviewboard/webapi/resources/validate_diff.py
	reviewboard/webapi/resources/validate_diffcommit.py
	reviewboard/webapi/tests/test_repository_branches.py
	5 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-6.x (e3f7948)