Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add util for finding credential helper to use #15707

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/main/java/com/google/devtools/build/lib/authandtls/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ package(default_visibility = ["//src:__subpackages__"])

filegroup(
name = "srcs",
srcs = glob(["**"]),
srcs = glob(["**"]) + [
"//src/main/java/com/google/devtools/build/lib/authandtls/credentialhelper:srcs",
],
visibility = ["//src:__subpackages__"],
)

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
load("@rules_java//java:defs.bzl", "java_library")

filegroup(
name = "srcs",
srcs = glob(["**"]),
visibility = ["//src:__subpackages__"],
)

java_library(
name = "credentialhelper",
srcs = glob(["*.java"]),
visibility = ["//src:__subpackages__"],
deps = [
"//src/main/java/com/google/devtools/build/lib/vfs",
"//third_party:error_prone_annotations",
"//third_party:guava",
],
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Copyright 2022 The Bazel Authors. All rights reserved.
//
// 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.

package com.google.devtools.build.lib.authandtls.credentialhelper;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.devtools.build.lib.vfs.Path;
import com.google.errorprone.annotations.Immutable;

@Immutable
public final class CredentialHelper {
// `Path` is immutable, but not annotated.
@SuppressWarnings("Immutable")
private final Path path;

CredentialHelper(Path path) {
this.path = Preconditions.checkNotNull(path);
}

@VisibleForTesting
Path getPath() {
return path;
}

// TODO(yannic): Implement running the helper subprocess.
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
// Copyright 2022 The Bazel Authors. All rights reserved.
//
// 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.

package com.google.devtools.build.lib.authandtls.credentialhelper;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.vfs.Path;
import com.google.errorprone.annotations.Immutable;
import java.io.IOException;
import java.net.URI;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

/**
* A provider for {@link CredentialHelper}s.
*
* <p>This class is used to find the right {@link CredentialHelper} for a {@link URI}, using the
* most specific match.
*/
@Immutable
public final class CredentialHelperProvider {
// `Path` is immutable, but not annotated.
@SuppressWarnings("Immutable")
private final Optional<Path> defaultHelper;

@SuppressWarnings("Immutable")
private final ImmutableMap<String, Path> hosts;

@SuppressWarnings("Immutable")
private final ImmutableMap<String, Path> wildcards;
Yannic marked this conversation as resolved.
Show resolved Hide resolved

private CredentialHelperProvider(
Optional<Path> defaultHelper,
ImmutableMap<String, Path> hosts,
ImmutableMap<String, Path> wildcards) {
this.defaultHelper = Preconditions.checkNotNull(defaultHelper);
this.hosts = Preconditions.checkNotNull(hosts);
this.wildcards = Preconditions.checkNotNull(wildcards);
}

/**
* Returns {@link CredentialHelper} to use for getting credentials for connection to the provided
* {@link URI}.
*
* @param uri The {@link URI} to get a credential helper for.
* @return The {@link CredentialHelper}, or nothing if no {@link CredentialHelper} is configured
* for the provided {@link URI}.
*/
public Optional<CredentialHelper> findCredentialHelper(URI uri) {
Preconditions.checkNotNull(uri);

String host = Preconditions.checkNotNull(uri.getHost());
Optional<Path> credentialHelper =
findHostCredentialHelper(host)
.or(() -> findWildcardCredentialHelper(host))
.or(() -> defaultHelper);
return credentialHelper.map(path -> new CredentialHelper(path));
}

private Optional<Path> findHostCredentialHelper(String host) {
Preconditions.checkNotNull(host);

return Optional.ofNullable(hosts.get(host));
}

private Optional<Path> findWildcardCredentialHelper(String host) {
Preconditions.checkNotNull(host);

return Optional.ofNullable(wildcards.get(host))
.or(
() -> {
int dot = host.indexOf('.');
if (dot < 0) {
// We reached the last segment, end.
return Optional.empty();
}
return findWildcardCredentialHelper(host.substring(dot + 1));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be clearer to encapsulate this logic in a boolean hostMatchesPattern(String pattern, String host) helper.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly refactored the "get parent domain" logic into helper function.

});
}

/** Returns a new bBuilder for a {@link CredentialHelperProvider}. */
Yannic marked this conversation as resolved.
Show resolved Hide resolved
public static Builder builder() {
return new Builder();
}

/** Builder for {@link CredentialHelperProvider}. */
public static final class Builder {
private Optional<Path> defaultHelper = Optional.empty();
private Map<String, Path> hosts = new HashMap<>();
private Map<String, Path> wildcards = new HashMap<>();

private void checkHelper(Path path) throws IOException {
Preconditions.checkNotNull(path);
Preconditions.checkArgument(
path.isExecutable(), "Credential helper %s is not executable", path);
}

/**
* Adds a default credential helper to use for all {@link URI}s that don't specify a more
* specific credential helper.
*/
public Builder add(Path helper) throws IOException {
checkHelper(helper);

defaultHelper = Optional.of(helper);
return this;
}

/**
* Adds a credential helper to use for all {@link URI}s matching the provided pattern.
*
* <p>As of 2022-06-20, only matching based on (wildcard) domain name is supported.
*
* <p>If {@code pattern} starts with {@code *.}, it is considered a wildcard pattern matching
* all subdomains in addition to the domain itself. For example {@code *.example.com} would
* match {@code example.com}, {@code foo.example.com}, {@code bar.example.com}, {@code
* baz.bar.example.com} and so on, but not anything that isn't a subdomain of {@code
* example.com}.
*/
public Builder add(String pattern, Path helper) throws IOException {
Preconditions.checkNotNull(pattern);
checkHelper(helper);

if (pattern.startsWith("*.")) {
wildcards.put(pattern.substring(2), helper);
} else {
hosts.put(pattern, helper);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should do more exhaustive validation to reject stuff like foo.*.bar, http://foo.bar, http://foo.bar/path/to/resource, or http://foo.bar:8080.

To be concrete, I think we want the pattern to match the regex (\*|[-a-zA-Z0-9]+)(\.[-a-zA-Z0-9]+)+ (technically domain names are stricter, but this should cover most misuses).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done (+ also handling non-ascii DNS names correctly)

}

return this;
}

public CredentialHelperProvider build() {
return new CredentialHelperProvider(
defaultHelper, ImmutableMap.copyOf(hosts), ImmutableMap.copyOf(wildcards));
}
}
}
4 changes: 3 additions & 1 deletion src/test/java/com/google/devtools/build/lib/authandtls/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ licenses(["notice"])
filegroup(
name = "srcs",
testonly = 0,
srcs = glob(["**"]),
srcs = glob(["**"]) + [
"//src/test/java/com/google/devtools/build/lib/authandtls/credentialhelper:srcs",
],
visibility = ["//src:__subpackages__"],
)

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
load("@rules_java//java:defs.bzl", "java_test")

licenses(["notice"])

filegroup(
name = "srcs",
testonly = 0,
srcs = glob(["**"]),
visibility = ["//src:__subpackages__"],
)

java_test(
name = "credentialhelper",
srcs = glob(["*.java"]),
test_class = "com.google.devtools.build.lib.AllTests",
runtime_deps = [
"//src/test/java/com/google/devtools/build/lib:test_runner",
],
deps = [
"//src/main/java/com/google/devtools/build/lib/authandtls/credentialhelper",
"//src/main/java/com/google/devtools/build/lib/vfs",
"//src/main/java/com/google/devtools/build/lib/vfs:pathfragment",
"//src/main/java/com/google/devtools/build/lib/vfs/inmemoryfs",
"//third_party:junit4",
"//third_party:truth",
],
)
Loading