backend-plugin-api: add publicKeyStore service

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>

packages/backend-plugin-api/src/services/definitions/PublicKeyStoreService.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { JsonObject } from '@backstage/types';
+
+/**
+ * @public
+ */
+export interface PublicKeyStoreService {
+  listKeys(): Promise<{ keys: JsonObject[] }>;
+  addKey(options: {
+    id: string;
+    key: JsonObject;
+    expiresAt: Date;
+  }): Promise<void>;
+}

packages/backend-plugin-api/src/services/definitions/coreServices.ts

@@ -132,6 +132,18 @@ export namespace coreServices {
     import('./PluginMetadataService').PluginMetadataService
   >({ id: 'core.pluginMetadata' });
 
+  /**
+   * The service reference for the plugin scoped {@link PublicKeyStoreService}.
+   *
+   * @public
+   */
+  export const publicKeyStore = createServiceRef<
+    import('./PublicKeyStoreService').PublicKeyStoreService
+  >({
+    id: 'core.publicKeyStore',
+    scope: 'plugin',
+  });
+
   /**
    * The service reference for the root scoped {@link RootHttpRouterService}.
    *

packages/backend-plugin-api/src/services/definitions/index.ts

@@ -68,3 +68,4 @@ export type {
 } from './UrlReaderService';
 export type { BackstageUserInfo, UserInfoService } from './UserInfoService';
 export type { IdentityService } from './IdentityService';
+export type { PublicKeyStoreService } from './PublicKeyStoreService';