1"use strict";(self.webpackChunkveramo_site_docs=self.webpackChunkveramo_site_docs||[]).push([["13717"],{79495(e,t,s){s.r(t),s.d(t,{metadata:()=>r,default:()=>h,frontMatter:()=>a,contentTitle:()=>d,toc:()=>o,assets:()=>c});var r=JSON.parse('{"id":"api/data-store.privatekeystore","title":"PrivateKeyStore class","description":"PrivateKeyStore class","source":"@site/docs/api/data-store.privatekeystore.md","sourceDirName":"api","slug":"/api/data-store.privatekeystore","permalink":"/docs/api/data-store.privatekeystore","draft":false,"unlisted":false,"editUrl":"https://github.com/veramolabs/veramo-website/edit/main/docs/api/data-store.privatekeystore.md","tags":[],"version":"current","frontMatter":{"id":"data-store.privatekeystore","title":"PrivateKeyStore class","hide_title":true}}'),n=s(86070),i=s(38322);let a={id:"data-store.privatekeystore",title:"PrivateKeyStore class",hide_title:!0},d,c={},o=[{value:"PrivateKeyStore class",id:"privatekeystore-class",level:2},{value:"Constructors",id:"constructors",level:2},{value:"Methods",id:"methods",level:2}];function l(e){let t={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"privatekeystore-class",children:"PrivateKeyStore class"}),"\n",(0,n.jsxs)(t.p,{children:["An implementation of ",(0,n.jsx)(t.a,{href:"/docs/api/key-manager.abstractprivatekeystore",children:"AbstractPrivateKeyStore"})," that uses a TypeORM database connection to store private key material."]}),"\n",(0,n.jsxs)(t.p,{children:["The keys can be encrypted while at rest if this class is initialized with an ",(0,n.jsx)(t.a,{href:"/docs/api/key-manager.abstractsecretbox",children:"AbstractSecretBox"})," implementation."]}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.strong,{children:"Signature:"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-typescript",children:"export declare class PrivateKeyStore extends AbstractPrivateKeyStore\n"})}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Extends:"})," ",(0,n.jsx)(t.a,{href:"/docs/api/key-manager.abstractprivatekeystore",children:"AbstractPrivateKeyStore"})]}),"\n",(0,n.jsx)(t.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.th,{children:["\n",(0,n.jsx)(t.p,{children:"Constructor"}),"\n"]}),(0,n.jsxs)(t.th,{children:["\n",(0,n.jsx)(t.p,{children:"Modifiers"}),"\n"]}),(0,n.jsxs)(t.th,{children:["\n",(0,n.jsx)(t.p,{children:"Description"}),"\n"]})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:["\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"/docs/api/data-store.privatekeystore._constructor_",children:"(constructor)(dbConnection, secretBox)"})}),"\n"]}),(0,n.jsx)(t.td,{children:"\n"}),(0,n.jsxs)(t.td,{children:["\n",(0,n.jsxs)(t.p,{children:["Constructs a new instance of the ",(0,n.jsx)(t.code,{children:"PrivateKeyStore"})," class"]}),"\n"]})]})})]}),"\n",(0,n.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.th,{children:["\n",(0,n.jsx)(t.p,{children:"Method"}),"\n"]}),(0,n.jsxs)(t.th,{children:["\n",(0,n.jsx)(t.p,{children:"Modifiers"}),"\n"]}),(0,n.jsxs)(t.th,{children:["\n",(0,n.jsx)(t.p,{children:"Description"}),"\n"]})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:["\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"/docs/api/data-store.privatekeystore.deletekey",children:"deleteKey({ alias })"})}),"\n"]}),(0,n.jsx)(t.td,{children:"\n"}),(0,n.jsx)(t.td,{children:"\n"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:["\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"/docs/api/data-store.privatekeystore.getkey",children:"getKey({ alias })"})}),"\n"]}),(0,n.jsx)(t.td,{children:"\n"}),(0,n.jsx)(t.td,{children:"\n"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:["\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"/docs/api/data-store.privatekeystore.importkey",children:"importKey(args)"})}),"\n"]}),(0,n.jsx)(t.td,{children:"\n"}),(0,n.jsx)(t.td,{children:"\n"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:["\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"/docs/api/data-store.privatekeystore.listkeys",children:"listKeys()"})}),"\n"]}),(0,n.jsx)(t.td,{children:"\n"}),(0,n.jsx)(t.td,{children:"\n"})]})]})]})]})}function h(e={}){let{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},38322(e,t,s){s.d(t,{R:()=>a,x:()=>d});var r=s(30758);let n={},i=r.createContext(n);function a(e){let t=r.useContext(i);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.