call-credentials.js 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. "use strict";
  2. /*
  3. * Copyright 2019 gRPC authors.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. *
  17. */
  18. Object.defineProperty(exports, "__esModule", { value: true });
  19. exports.CallCredentials = void 0;
  20. const metadata_1 = require("./metadata");
  21. function isCurrentOauth2Client(client) {
  22. return ('getRequestHeaders' in client &&
  23. typeof client.getRequestHeaders === 'function');
  24. }
  25. /**
  26. * A class that represents a generic method of adding authentication-related
  27. * metadata on a per-request basis.
  28. */
  29. class CallCredentials {
  30. /**
  31. * Creates a new CallCredentials object from a given function that generates
  32. * Metadata objects.
  33. * @param metadataGenerator A function that accepts a set of options, and
  34. * generates a Metadata object based on these options, which is passed back
  35. * to the caller via a supplied (err, metadata) callback.
  36. */
  37. static createFromMetadataGenerator(metadataGenerator) {
  38. return new SingleCallCredentials(metadataGenerator);
  39. }
  40. /**
  41. * Create a gRPC credential from a Google credential object.
  42. * @param googleCredentials The authentication client to use.
  43. * @return The resulting CallCredentials object.
  44. */
  45. static createFromGoogleCredential(googleCredentials) {
  46. return CallCredentials.createFromMetadataGenerator((options, callback) => {
  47. let getHeaders;
  48. if (isCurrentOauth2Client(googleCredentials)) {
  49. getHeaders = googleCredentials.getRequestHeaders(options.service_url);
  50. }
  51. else {
  52. getHeaders = new Promise((resolve, reject) => {
  53. googleCredentials.getRequestMetadata(options.service_url, (err, headers) => {
  54. if (err) {
  55. reject(err);
  56. return;
  57. }
  58. if (!headers) {
  59. reject(new Error('Headers not set by metadata plugin'));
  60. return;
  61. }
  62. resolve(headers);
  63. });
  64. });
  65. }
  66. getHeaders.then(headers => {
  67. const metadata = new metadata_1.Metadata();
  68. for (const key of Object.keys(headers)) {
  69. metadata.add(key, headers[key]);
  70. }
  71. callback(null, metadata);
  72. }, err => {
  73. callback(err);
  74. });
  75. });
  76. }
  77. static createEmpty() {
  78. return new EmptyCallCredentials();
  79. }
  80. }
  81. exports.CallCredentials = CallCredentials;
  82. class ComposedCallCredentials extends CallCredentials {
  83. constructor(creds) {
  84. super();
  85. this.creds = creds;
  86. }
  87. async generateMetadata(options) {
  88. const base = new metadata_1.Metadata();
  89. const generated = await Promise.all(this.creds.map(cred => cred.generateMetadata(options)));
  90. for (const gen of generated) {
  91. base.merge(gen);
  92. }
  93. return base;
  94. }
  95. compose(other) {
  96. return new ComposedCallCredentials(this.creds.concat([other]));
  97. }
  98. _equals(other) {
  99. if (this === other) {
  100. return true;
  101. }
  102. if (other instanceof ComposedCallCredentials) {
  103. return this.creds.every((value, index) => value._equals(other.creds[index]));
  104. }
  105. else {
  106. return false;
  107. }
  108. }
  109. }
  110. class SingleCallCredentials extends CallCredentials {
  111. constructor(metadataGenerator) {
  112. super();
  113. this.metadataGenerator = metadataGenerator;
  114. }
  115. generateMetadata(options) {
  116. return new Promise((resolve, reject) => {
  117. this.metadataGenerator(options, (err, metadata) => {
  118. if (metadata !== undefined) {
  119. resolve(metadata);
  120. }
  121. else {
  122. reject(err);
  123. }
  124. });
  125. });
  126. }
  127. compose(other) {
  128. return new ComposedCallCredentials([this, other]);
  129. }
  130. _equals(other) {
  131. if (this === other) {
  132. return true;
  133. }
  134. if (other instanceof SingleCallCredentials) {
  135. return this.metadataGenerator === other.metadataGenerator;
  136. }
  137. else {
  138. return false;
  139. }
  140. }
  141. }
  142. class EmptyCallCredentials extends CallCredentials {
  143. generateMetadata(options) {
  144. return Promise.resolve(new metadata_1.Metadata());
  145. }
  146. compose(other) {
  147. return other;
  148. }
  149. _equals(other) {
  150. return other instanceof EmptyCallCredentials;
  151. }
  152. }
  153. //# sourceMappingURL=call-credentials.js.map