google-cloud-os_login 0.7.0 → 1.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -54
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +323 -0
  6. data/README.md +36 -24
  7. data/lib/{google/cloud/os_login/v1/doc/google/protobuf/empty.rb → google-cloud-os_login.rb} +4 -14
  8. data/lib/google/cloud/os_login.rb +88 -117
  9. data/lib/google/cloud/os_login/version.rb +6 -2
  10. metadata +74 -61
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/os_login/v1.rb +0 -148
  13. data/lib/google/cloud/os_login/v1/credentials.rb +0 -42
  14. data/lib/google/cloud/os_login/v1/doc/google/cloud/oslogin/common/common.rb +0 -89
  15. data/lib/google/cloud/os_login/v1/doc/google/cloud/oslogin/v1/oslogin.rb +0 -103
  16. data/lib/google/cloud/os_login/v1/doc/google/protobuf/field_mask.rb +0 -222
  17. data/lib/google/cloud/os_login/v1/os_login_service_client.rb +0 -506
  18. data/lib/google/cloud/os_login/v1/os_login_service_client_config.json +0 -56
  19. data/lib/google/cloud/os_login/v1beta.rb +0 -148
  20. data/lib/google/cloud/os_login/v1beta/credentials.rb +0 -44
  21. data/lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/common.rb +0 -67
  22. data/lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/common/common.rb +0 -89
  23. data/lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/v1beta/oslogin.rb +0 -103
  24. data/lib/google/cloud/os_login/v1beta/doc/google/protobuf/empty.rb +0 -29
  25. data/lib/google/cloud/os_login/v1beta/doc/google/protobuf/field_mask.rb +0 -222
  26. data/lib/google/cloud/os_login/v1beta/os_login_service_client.rb +0 -511
  27. data/lib/google/cloud/os_login/v1beta/os_login_service_client_config.json +0 -56
  28. data/lib/google/cloud/oslogin/common/common_pb.rb +0 -40
  29. data/lib/google/cloud/oslogin/v1/oslogin_pb.rb +0 -65
  30. data/lib/google/cloud/oslogin/v1/oslogin_services_pb.rb +0 -65
  31. data/lib/google/cloud/oslogin/v1beta/oslogin_pb.rb +0 -65
  32. data/lib/google/cloud/oslogin/v1beta/oslogin_services_pb.rb +0 -65
data/LICENSE DELETED
@@ -1,201 +0,0 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- https://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
177
-
178
- APPENDIX: How to apply the Apache License to your work.
179
-
180
- To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
182
- replaced with your own identifying information. (Don't include
183
- the brackets!) The text should be enclosed in the appropriate
184
- comment syntax for the file format. We also recommend that a
185
- file or class name and description of purpose be included on the
186
- same "printed page" as the copyright notice for easier
187
- identification within third-party archives.
188
-
189
- Copyright [yyyy] [name of copyright owner]
190
-
191
- Licensed under the Apache License, Version 2.0 (the "License");
192
- you may not use this file except in compliance with the License.
193
- You may obtain a copy of the License at
194
-
195
- https://www.apache.org/licenses/LICENSE-2.0
196
-
197
- Unless required by applicable law or agreed to in writing, software
198
- distributed under the License is distributed on an "AS IS" BASIS,
199
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
- See the License for the specific language governing permissions and
201
- limitations under the License.
@@ -1,148 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- require "google/cloud/os_login/v1/os_login_service_client"
17
-
18
- module Google
19
- module Cloud
20
- module OsLogin
21
- # rubocop:disable LineLength
22
-
23
- ##
24
- # # Ruby Client for Cloud OS Login API
25
- #
26
- # [Cloud OS Login API][Product Documentation]:
27
- # You can use OS Login to manage access to your VM instances using IAM roles.
28
- # - [Product Documentation][]
29
- #
30
- # ## Quick Start
31
- # In order to use this library, you first need to go through the following
32
- # steps:
33
- #
34
- # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
35
- # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
36
- # 3. [Enable the Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
37
- # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-os_login/latest/file.AUTHENTICATION.html)
38
- #
39
- # ### Installation
40
- # ```
41
- # $ gem install google-cloud-os_login
42
- # ```
43
- #
44
- # ### Next Steps
45
- # - Read the [Cloud OS Login API Product documentation][Product Documentation]
46
- # to learn more about the product and see How-to Guides.
47
- # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
48
- # to see the full list of Cloud APIs that we cover.
49
- #
50
- # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
51
- #
52
- # ## Enabling Logging
53
- #
54
- # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
55
- # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
56
- # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
57
- # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
58
- # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
59
- #
60
- # Configuring a Ruby stdlib logger:
61
- #
62
- # ```ruby
63
- # require "logger"
64
- #
65
- # module MyLogger
66
- # LOGGER = Logger.new $stderr, level: Logger::WARN
67
- # def logger
68
- # LOGGER
69
- # end
70
- # end
71
- #
72
- # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
73
- # module GRPC
74
- # extend MyLogger
75
- # end
76
- # ```
77
- #
78
- module V1
79
- # rubocop:enable LineLength
80
-
81
- ##
82
- # Cloud OS Login API
83
- #
84
- # The Cloud OS Login API allows you to manage users and their associated SSH
85
- # public keys for logging into virtual machines on Google Cloud Platform.
86
- #
87
- # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
88
- # Provides the means for authenticating requests made by the client. This parameter can
89
- # be many types.
90
- # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
91
- # authenticating requests made by this client.
92
- # A `String` will be treated as the path to the keyfile to be used for the construction of
93
- # credentials for this client.
94
- # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
95
- # credentials for this client.
96
- # A `GRPC::Core::Channel` will be used to make calls through.
97
- # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
98
- # should already be composed with a `GRPC::Core::CallCredentials` object.
99
- # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
100
- # metadata for requests, generally, to give OAuth credentials.
101
- # @param scopes [Array<String>]
102
- # The OAuth scopes for this service. This parameter is ignored if
103
- # an updater_proc is supplied.
104
- # @param client_config [Hash]
105
- # A Hash for call options for each method. See
106
- # Google::Gax#construct_settings for the structure of
107
- # this data. Falls back to the default config if not specified
108
- # or the specified config is missing data points.
109
- # @param timeout [Numeric]
110
- # The default timeout, in seconds, for calls made through this client.
111
- # @param metadata [Hash]
112
- # Default metadata to be sent with each request. This can be overridden on a per call basis.
113
- # @param service_address [String]
114
- # Override for the service hostname, or `nil` to leave as the default.
115
- # @param service_port [Integer]
116
- # Override for the service port, or `nil` to leave as the default.
117
- # @param exception_transformer [Proc]
118
- # An optional proc that intercepts any exceptions raised during an API call to inject
119
- # custom error handling.
120
- def self.new \
121
- credentials: nil,
122
- scopes: nil,
123
- client_config: nil,
124
- timeout: nil,
125
- metadata: nil,
126
- service_address: nil,
127
- service_port: nil,
128
- exception_transformer: nil,
129
- lib_name: nil,
130
- lib_version: nil
131
- kwargs = {
132
- credentials: credentials,
133
- scopes: scopes,
134
- client_config: client_config,
135
- timeout: timeout,
136
- metadata: metadata,
137
- exception_transformer: exception_transformer,
138
- lib_name: lib_name,
139
- service_address: service_address,
140
- service_port: service_port,
141
- lib_version: lib_version
142
- }.select { |_, v| v != nil }
143
- Google::Cloud::OsLogin::V1::OsLoginServiceClient.new(**kwargs)
144
- end
145
- end
146
- end
147
- end
148
- end
@@ -1,42 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- require "googleauth"
17
-
18
- module Google
19
- module Cloud
20
- module OsLogin
21
- module V1
22
- class Credentials < Google::Auth::Credentials
23
- SCOPE = [
24
- "https://www.googleapis.com/auth/cloud-platform",
25
- "https://www.googleapis.com/auth/compute"
26
- ].freeze
27
- PATH_ENV_VARS = %w(OS_LOGIN_CREDENTIALS
28
- OS_LOGIN_KEYFILE
29
- GOOGLE_CLOUD_CREDENTIALS
30
- GOOGLE_CLOUD_KEYFILE
31
- GCLOUD_KEYFILE)
32
- JSON_ENV_VARS = %w(OS_LOGIN_CREDENTIALS_JSON
33
- OS_LOGIN_KEYFILE_JSON
34
- GOOGLE_CLOUD_CREDENTIALS_JSON
35
- GOOGLE_CLOUD_KEYFILE_JSON
36
- GCLOUD_KEYFILE_JSON)
37
- DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
38
- end
39
- end
40
- end
41
- end
42
- end
@@ -1,89 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module OsLogin
19
- module Common
20
- # The POSIX account information associated with a Google account.
21
- # @!attribute [rw] primary
22
- # @return [true, false]
23
- # Only one POSIX account can be marked as primary.
24
- # @!attribute [rw] username
25
- # @return [String]
26
- # The username of the POSIX account.
27
- # @!attribute [rw] uid
28
- # @return [Integer]
29
- # The user ID.
30
- # @!attribute [rw] gid
31
- # @return [Integer]
32
- # The default group ID.
33
- # @!attribute [rw] home_directory
34
- # @return [String]
35
- # The path to the home directory for this account.
36
- # @!attribute [rw] shell
37
- # @return [String]
38
- # The path to the logic shell for this account.
39
- # @!attribute [rw] gecos
40
- # @return [String]
41
- # The GECOS (user information) entry for this account.
42
- # @!attribute [rw] system_id
43
- # @return [String]
44
- # System identifier for which account the username or uid applies to.
45
- # By default, the empty value is used.
46
- # @!attribute [rw] account_id
47
- # @return [String]
48
- # Output only. A POSIX account identifier.
49
- # @!attribute [rw] operating_system_type
50
- # @return [Google::Cloud::OsLogin::Common::OperatingSystemType]
51
- # The operating system type where this account applies.
52
- # @!attribute [rw] name
53
- # @return [String]
54
- # Output only. The canonical resource name.
55
- class PosixAccount; end
56
-
57
- # The SSH public key information associated with a Google account.
58
- # @!attribute [rw] key
59
- # @return [String]
60
- # Public key text in SSH format, defined by
61
- # <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a>
62
- # section 6.6.
63
- # @!attribute [rw] expiration_time_usec
64
- # @return [Integer]
65
- # An expiration time in microseconds since epoch.
66
- # @!attribute [rw] fingerprint
67
- # @return [String]
68
- # Output only. The SHA-256 fingerprint of the SSH public key.
69
- # @!attribute [rw] name
70
- # @return [String]
71
- # Output only. The canonical resource name.
72
- class SshPublicKey; end
73
-
74
- # The operating system options for account entries.
75
- module OperatingSystemType
76
- # The operating system type associated with the user account information is
77
- # unspecified.
78
- OPERATING_SYSTEM_TYPE_UNSPECIFIED = 0
79
-
80
- # Linux user account information.
81
- LINUX = 1
82
-
83
- # Windows user account information.
84
- WINDOWS = 2
85
- end
86
- end
87
- end
88
- end
89
- end