token-generator.d.ts 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * @license
  4. * Copyright 2017 Google Inc.
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the "License");
  7. * you may not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. /// <reference types="node" />
  19. import { CryptoSigner } from '../utils/crypto-signer';
  20. import { Algorithm } from 'jsonwebtoken';
  21. export declare const BLACKLISTED_CLAIMS: string[];
  22. /**
  23. * A CryptoSigner implementation that is used when communicating with the Auth emulator.
  24. * It produces unsigned tokens.
  25. */
  26. export declare class EmulatedSigner implements CryptoSigner {
  27. algorithm: Algorithm;
  28. /**
  29. * @inheritDoc
  30. */
  31. sign(buffer: Buffer): Promise<Buffer>;
  32. /**
  33. * @inheritDoc
  34. */
  35. getAccountId(): Promise<string>;
  36. }
  37. /**
  38. * Creates a new FirebaseAuthError by extracting the error code, message and other relevant
  39. * details from a CryptoSignerError.
  40. *
  41. * @param err - The Error to convert into a FirebaseAuthError error
  42. * @returns A Firebase Auth error that can be returned to the user.
  43. */
  44. export declare function handleCryptoSignerError(err: Error): Error;