Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove distinction between build and run accounts #6952

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
85 changes: 24 additions & 61 deletions src/apphosting/secrets/dialogs.ts
@@ -1,7 +1,7 @@
import * as clc from "colorette";
const Table = require("cli-table");

import { MultiServiceAccounts, ServiceAccounts, serviceAccountsForBackend, toMulti } from ".";
import { serviceAccountsForBackend } from ".";
import * as apphosting from "../../gcp/apphosting";
import * as prompt from "../../prompt";
import * as utils from "../../utils";
Expand All @@ -13,8 +13,7 @@ import * as env from "../../functions/env";
interface BackendMetadata {
location: string;
id: string;
buildServiceAccount: string;
runServiceAccount: string;
serviceAccounts: string[];
}

/**
Expand All @@ -28,7 +27,11 @@ export function toMetadata(
for (const backend of backends) {
// Splits format projects/<unused>/locations/<location>/backends/<id>
const [, , , location, , id] = backend.name.split("/");
metadata.push({ location, id, ...serviceAccountsForBackend(projectNumber, backend) });
metadata.push({
location,
id,
serviceAccounts: serviceAccountsForBackend(projectNumber, backend),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is updating this field to be a Set an option?

});
}
return metadata.sort((left, right) => {
const cmplocation = left.location.localeCompare(right.location);
Expand All @@ -39,22 +42,10 @@ export function toMetadata(
});
}

/** Displays a single service account or a comma separated list of service accounts. */
export function serviceAccountDisplay(metadata: ServiceAccounts): string {
if (sameServiceAccount(metadata)) {
return metadata.runServiceAccount;
}
return `${metadata.buildServiceAccount}, ${metadata.runServiceAccount}`;
}

function sameServiceAccount(metadata: ServiceAccounts): boolean {
return metadata.buildServiceAccount === metadata.runServiceAccount;
}

const matchesServiceAccounts = (target: ServiceAccounts) => (test: ServiceAccounts) => {
const matchesServiceAccounts = (target: BackendMetadata) => (test: BackendMetadata) => {
return (
target.buildServiceAccount === test.buildServiceAccount &&
target.runServiceAccount === test.runServiceAccount
target.serviceAccounts.length === test.serviceAccounts.length &&
target.serviceAccounts.every((sa) => test.serviceAccounts.indexOf(sa) !== -1)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having BackendMetadata.serviceAccounts be a Set could help making equality checks a little more straightforward. Otherwise, we end up with an order-dependent equality check which may be unexpected

);
};

Expand All @@ -68,38 +59,12 @@ export function tableForBackends(
const headers = [
"location",
"backend",
metadata.every(sameServiceAccount) ? "service account" : "service accounts",
metadata.every((m) => m.serviceAccounts.length === 1) ? "service account" : "service accounts",
];
const rows = metadata.map((m) => [m.location, m.id, serviceAccountDisplay(m)]);
const rows = metadata.map((m) => [m.location, m.id, m.serviceAccounts.join(", ")]);
return [headers, rows];
}

/**
* Returns a MultiServiceAccounts for all selected service accounts in a ServiceAccount[].
* If a service account is ever a "build" account in input, it will be a "build" account in the
* output. Otherwise, it will be a "run" account.
*/
export function selectFromMetadata(
input: ServiceAccounts[],
selected: string[],
): MultiServiceAccounts {
const buildAccounts = new Set<string>();
const runAccounts = new Set<string>();

for (const sa of selected) {
if (input.find((m) => m.buildServiceAccount === sa)) {
buildAccounts.add(sa);
} else {
runAccounts.add(sa);
}
}

return {
buildServiceAccounts: [...buildAccounts],
runServiceAccounts: [...runAccounts],
};
}

/** Common warning log that there are no backends. Exported to make tests easier. */
export const WARN_NO_BACKENDS =
"To use this secret, your backend's service account must have secret accessor permission. " +
Expand All @@ -117,7 +82,7 @@ export async function selectBackendServiceAccounts(
projectNumber: string,
projectId: string,
options: any,
): Promise<MultiServiceAccounts> {
): Promise<string[]> {
const listBackends = await apphosting.listBackends(projectId, "-");

if (listBackends.unreachable.length) {
Expand All @@ -130,7 +95,7 @@ export async function selectBackendServiceAccounts(

if (!listBackends.backends.length) {
utils.logLabeledWarning("apphosting", WARN_NO_BACKENDS);
return { buildServiceAccounts: [], runServiceAccounts: [] };
return [];
}

if (listBackends.backends.length === 1) {
Expand All @@ -141,10 +106,10 @@ export async function selectBackendServiceAccounts(
"To use this secret, your backend's service account must have secret accessor permission. Would you like to grant it now?",
});
if (grant) {
return toMulti(serviceAccountsForBackend(projectNumber, listBackends.backends[0]));
return serviceAccountsForBackend(projectNumber, listBackends.backends[0]);
}
utils.logLabeledBullet("apphosting", GRANT_ACCESS_IN_FUTURE);
return { buildServiceAccounts: [], runServiceAccounts: [] };
return [];
}

const metadata: BackendMetadata[] = toMetadata(projectNumber, listBackends.backends);
Expand All @@ -153,8 +118,8 @@ export async function selectBackendServiceAccounts(
utils.logLabeledBullet(
"apphosting",
"To use this secret, your backend's service account must have secret accessor permission. All of your backends use " +
(sameServiceAccount(metadata[0]) ? "service account " : "service accounts ") +
serviceAccountDisplay(metadata[0]) +
(metadata[0].serviceAccounts.length === 1 ? "service account " : "service accounts ") +
metadata[0].serviceAccounts.join(", ") +
". Granting access to one backend will grant access to all backends.",
);
const grant = await prompt.confirm({
Expand All @@ -163,13 +128,10 @@ export async function selectBackendServiceAccounts(
message: "Would you like to grant it now?",
});
if (grant) {
return selectFromMetadata(metadata, [
metadata[0].buildServiceAccount,
metadata[0].runServiceAccount,
]);
return metadata[0].serviceAccounts;
}
utils.logLabeledBullet("apphosting", GRANT_ACCESS_IN_FUTURE);
return { buildServiceAccounts: [], runServiceAccounts: [] };
return [];
}

utils.logLabeledBullet(
Expand All @@ -185,8 +147,9 @@ export async function selectBackendServiceAccounts(
logger.info(table.toString());

const allAccounts = metadata.reduce((accum: Set<string>, row) => {
accum.add(row.buildServiceAccount);
accum.add(row.runServiceAccount);
for (const sa of row.serviceAccounts) {
accum.add(sa);
}
return accum;
}, new Set<string>());
const chosen = await prompt.promptOnce({
Expand All @@ -199,7 +162,7 @@ export async function selectBackendServiceAccounts(
if (!chosen.length) {
utils.logLabeledBullet("apphosting", GRANT_ACCESS_IN_FUTURE);
}
return selectFromMetadata(metadata, chosen);
return chosen;
}

function toUpperSnakeCase(key: string): string {
Expand Down
49 changes: 7 additions & 42 deletions src/apphosting/secrets/index.ts
Expand Up @@ -9,52 +9,18 @@ import { isFunctionsManaged } from "../../gcp/secretManager";
import * as utils from "../../utils";
import * as prompt from "../../prompt";

/** Interface for holding the service account pair for a given Backend. */
export interface ServiceAccounts {
buildServiceAccount: string;
runServiceAccount: string;
}

/**
* Interface for holding a collection of service accounts we need to grant access to.
* Build accounts are special because they also need secret viewer permissions to view versions
* and pin to the latest. Run accounts only need version accessor.
*/
export interface MultiServiceAccounts {
buildServiceAccounts: string[];
runServiceAccounts: string[];
}

/** Utility function to turn a single ServiceAccounts into a MultiServiceAccounts. */
export function toMulti(accounts: ServiceAccounts): MultiServiceAccounts {
const m: MultiServiceAccounts = {
buildServiceAccounts: [accounts.buildServiceAccount],
runServiceAccounts: [],
};
if (accounts.buildServiceAccount !== accounts.runServiceAccount) {
m.runServiceAccounts.push(accounts.runServiceAccount);
}
return m;
}

/**
* Finds the explicit service account used for a backend or, for legacy cases,
* the defaults for GCB and compute.
*/
export function serviceAccountsForBackend(
projectNumber: string,
backend: apphosting.Backend,
): ServiceAccounts {
): string[] {
if (backend.serviceAccount) {
return {
buildServiceAccount: backend.serviceAccount,
runServiceAccount: backend.serviceAccount,
};
return [backend.serviceAccount];
}
return {
buildServiceAccount: gcb.getDefaultServiceAccount(projectNumber),
runServiceAccount: gce.getDefaultServiceAccount(projectNumber),
};
return [gcb.getDefaultServiceAccount(projectNumber), gce.getDefaultServiceAccount(projectNumber)];
}

/**
Expand All @@ -63,20 +29,19 @@ export function serviceAccountsForBackend(
export async function grantSecretAccess(
projectId: string,
secretName: string,
accounts: MultiServiceAccounts,
accounts: string[],
): Promise<void> {
const members = accounts.map((a) => `serviceAccount:${a}`);
const newBindings: iam.Binding[] = [
{
role: "roles/secretmanager.secretAccessor",
members: [...accounts.buildServiceAccounts, ...accounts.runServiceAccounts].map(
(sa) => `serviceAccount:${sa}`,
),
members,
},
// Cloud Build needs the viewer role so that it can list secret versions and pin the Build to the
// latest version.
{
role: "roles/secretmanager.viewer",
members: accounts.buildServiceAccounts.map((sa) => `serviceAccount:${sa}`),
members,
},
];

Expand Down