fleet/frontend/interfaces/certificates.ts
Jordan Montgomery 994672ca20
Hydrant CA Feature Branch (#31807)
There are still some TODOs particularly within Gitops test code which
will be worked on in a followup PR

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files)
for more information.

- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes

## Testing

- [x] Added/updated automated tests
- [x] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)

- [ ] QA'd all new/changed functionality manually

For unreleased bug fixes in a release candidate, one of:

- [x] Confirmed that the fix is not expected to adversely impact load
test results
- [x] Alerted the release DRI if additional load testing is needed

## Database migrations

- [x] Checked table schema to confirm autoupdate
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).

## New Fleet configuration settings

- [ ] Setting(s) is/are explicitly excluded from GitOps

If you didn't check the box above, follow this checklist for
GitOps-enabled settings:

- [ ] Verified that the setting is exported via `fleetctl
generate-gitops`
- [x] Verified the setting is documented in a separate PR to [the GitOps
documentation](https://github.com/fleetdm/fleet/blob/main/docs/Configuration/yaml-files.md#L485)
- [x] Verified that the setting is cleared on the server if it is not
supplied in a YAML file (or that it is documented as being optional)
- [x] Verified that any relevant UI is disabled when GitOps mode is
enabled

---------

Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com>
2025-09-04 12:39:41 -04:00

132 lines
3 KiB
TypeScript

import { IListSort } from "./list_options";
export interface IHostCertificate {
id: number;
not_valid_after: string;
not_valid_before: string;
certificate_authority: boolean;
common_name: string;
key_algorithm: string;
key_strength: number;
key_usage: string;
serial: string;
signing_algorithm: string;
subject: {
country: string;
organization: string;
organizational_unit: string;
common_name: string;
};
issuer: {
country: string;
organization: string;
organizational_unit: string;
common_name: string;
};
source: string;
username: string;
}
export const CERTIFICATES_DEFAULT_SORT: IListSort = {
order_key: "common_name",
order_direction: "asc",
} as const;
/** This interface represent the smaller subset of cert authority data that is
returned for some of the cert authority endpoints */
export interface ICertificateAuthorityPartial {
id: number;
name: string;
type: ICertificateAuthorityType;
}
export interface ICertificatesNDES {
id?: number;
type?: "ndes_scep_proxy";
url: string;
admin_url: string;
username: string;
password: string;
}
export interface ICertificatesDigicert {
id?: number;
type?: "digicert";
name: string;
url: string;
api_token: string;
profile_id: string;
certificate_common_name: string;
certificate_user_principal_names: string[] | null;
certificate_seat_id: string;
}
export interface ICertificatesHydrant {
id?: number;
type?: "hydrant";
name: string;
url: string;
client_id: string;
client_secret: string;
}
export interface ICertificatesCustomSCEP {
id?: number;
type?: "custom_scep_proxy";
name: string;
url: string;
challenge: string;
}
export type ICertificateAuthorityType =
| "ndes_scep_proxy"
| "digicert"
| "custom_scep_proxy"
| "hydrant";
/** all the types of certificates */
export type ICertificateAuthority =
| ICertificatesNDES
| ICertificatesDigicert
| ICertificatesHydrant
| ICertificatesCustomSCEP;
export const isNDESCertAuthority = (
integration: ICertificateAuthority
): integration is ICertificatesNDES => {
return (
"admin_url" in integration &&
"username" in integration &&
"password" in integration
);
};
export const isDigicertCertAuthority = (
integration: ICertificateAuthority
): integration is ICertificatesDigicert => {
return (
"profile_id" in integration &&
"certificate_common_name" in integration &&
"certificate_user_principal_names" in integration &&
"certificate_seat_id" in integration
);
};
export const isHydrantCertAuthority = (
integration: ICertificateAuthority
): integration is ICertificatesHydrant => {
return (
"name" in integration &&
"url" in integration &&
"client_id" in integration &&
"client_secret" in integration
);
};
export const isCustomSCEPCertAuthority = (
integration: ICertificateAuthority
): integration is ICertificatesCustomSCEP => {
return (
"name" in integration && "url" in integration && "challenge" in integration
);
};