Skip to content

Commit

Permalink
apacheGH-37141: [GLib][FlightRPC] Add more ArrowFlight::ClientOptions…
Browse files Browse the repository at this point in the history 
… properties (apache#37142)

### Rationale for this change

ArrowFlight::ClientOptions only has `disable-server-verification` property for now.

### What changes are included in this PR?

Add the following properties:

* `tls-root-certificates`
* `override-host-name`
* `certificate-chain`
* `private-key`
* `write-size-limit-bytes`

### Are these changes tested?

Yes.

### Are there any user-facing changes?

Yes.
* Closes: apache#37141

Authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
  • Loading branch information
@kou
kou committed Aug 16, 2023
1 parent 3e7b35b commit f3010ba
Show file tree
Hide file tree
Showing 2 changed files with 155 additions and 3 deletions.
128 changes: 125 additions & 3 deletions c_glib/arrow-flight-glib/client.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,12 +166,17 @@ gaflight_call_options_foreach_header(GAFlightCallOptions *options,
}


typedef struct GAFlightClientOptionsPrivate_ {
struct GAFlightClientOptionsPrivate {
arrow::flight::FlightClientOptions options;
} GAFlightClientOptionsPrivate;
};

enum {
PROP_DISABLE_SERVER_VERIFICATION = 1,
PROP_TLS_ROOT_CERTIFICATES = 1,
PROP_OVERRIDE_HOST_NAME,
PROP_CERTIFICATE_CHAIN,
PROP_PRIVATE_KEY,
PROP_WRITE_SIZE_LIMIT_BYTES,
PROP_DISABLE_SERVER_VERIFICATION,
};

G_DEFINE_TYPE_WITH_PRIVATE(GAFlightClientOptions,
Expand Down Expand Up @@ -202,6 +207,21 @@ gaflight_client_options_set_property(GObject *object,
auto priv = GAFLIGHT_CLIENT_OPTIONS_GET_PRIVATE(object);

switch (prop_id) {
case PROP_TLS_ROOT_CERTIFICATES:
priv->options.tls_root_certs = g_value_get_string(value);
break;
case PROP_OVERRIDE_HOST_NAME:
priv->options.override_hostname = g_value_get_string(value);
break;
case PROP_CERTIFICATE_CHAIN:
priv->options.cert_chain = g_value_get_string(value);
break;
case PROP_PRIVATE_KEY:
priv->options.private_key = g_value_get_string(value);
break;
case PROP_WRITE_SIZE_LIMIT_BYTES:
priv->options.write_size_limit_bytes = g_value_get_int64(value);
break;
case PROP_DISABLE_SERVER_VERIFICATION:
priv->options.disable_server_verification = g_value_get_boolean(value);
break;
Expand All @@ -220,6 +240,21 @@ gaflight_client_options_get_property(GObject *object,
auto priv = GAFLIGHT_CLIENT_OPTIONS_GET_PRIVATE(object);

switch (prop_id) {
case PROP_TLS_ROOT_CERTIFICATES:
g_value_set_string(value, priv->options.tls_root_certs.c_str());
break;
case PROP_OVERRIDE_HOST_NAME:
g_value_set_string(value, priv->options.override_hostname.c_str());
break;
case PROP_CERTIFICATE_CHAIN:
g_value_set_string(value, priv->options.cert_chain.c_str());
break;
case PROP_PRIVATE_KEY:
g_value_set_string(value, priv->options.private_key.c_str());
break;
case PROP_WRITE_SIZE_LIMIT_BYTES:
g_value_set_int64(value, priv->options.write_size_limit_bytes);
break;
case PROP_DISABLE_SERVER_VERIFICATION:
g_value_set_boolean(value, priv->options.disable_server_verification);
break;
Expand Down Expand Up @@ -248,6 +283,93 @@ gaflight_client_options_class_init(GAFlightClientOptionsClass *klass)

auto options = arrow::flight::FlightClientOptions::Defaults();
GParamSpec *spec;
/**
* GAFlightClientOptions:tls-root-certificates:
*
* Root certificates to use for validating server certificates.
*
* Since: 14.0.0
*/
spec = g_param_spec_string("tls-root-certificates",
nullptr,
nullptr,
options.tls_root_certs.c_str(),
static_cast<GParamFlags>(G_PARAM_READWRITE));
g_object_class_install_property(gobject_class,
PROP_TLS_ROOT_CERTIFICATES,
spec);

/**
* GAFlightClientOptions:override-host-name:
*
* Override the host name checked by TLS. Use with caution.
*
* Since: 14.0.0
*/
spec = g_param_spec_string("override-host-name",
nullptr,
nullptr,
options.override_hostname.c_str(),
static_cast<GParamFlags>(G_PARAM_READWRITE));
g_object_class_install_property(gobject_class,
PROP_OVERRIDE_HOST_NAME,
spec);

/**
* GAFlightClientOptions:certificate-chain:
*
* The client certificate to use if using Mutual TLS.
*
* Since: 14.0.0
*/
spec = g_param_spec_string("certificate-chain",
nullptr,
nullptr,
options.cert_chain.c_str(),
static_cast<GParamFlags>(G_PARAM_READWRITE));
g_object_class_install_property(gobject_class,
PROP_CERTIFICATE_CHAIN,
spec);

/**
* GAFlightClientOptions:private-key:
*
* The private key associated with the client certificate for Mutual
* TLS.
*
* Since: 14.0.0
*/
spec = g_param_spec_string("private-key",
nullptr,
nullptr,
options.private_key.c_str(),
static_cast<GParamFlags>(G_PARAM_READWRITE));
g_object_class_install_property(gobject_class,
PROP_PRIVATE_KEY,
spec);

/**
* GAFlightClientOptions:write-size-limit-bytes:
*
* A soft limit on the number of bytes to write in a single batch
* when sending Arrow data to a server.
*
* Used to help limit server memory consumption. Only enabled if
* positive. When enabled, @GARROW_ERROR_IO may be yielded.
*
* Since: 14.0.0
*/
spec = g_param_spec_int64("write-size-limit-bytes",
nullptr,
nullptr,
INT64_MIN,
INT64_MAX,
options.write_size_limit_bytes,
static_cast<GParamFlags>(G_PARAM_READWRITE));
g_object_class_install_property(gobject_class,
PROP_WRITE_SIZE_LIMIT_BYTES,
spec);

/**
* GAFlightClientOptions:disable-server-verification:
*
Expand Down
30 changes: 30 additions & 0 deletions c_glib/test/flight/test-client-options.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,36 @@ def setup
@options = ArrowFlight::ClientOptions.new
end

def test_tls_root_certificates
assert_equal("", @options.tls_root_certificates)
@options.tls_root_certificates = "root"
assert_equal("root", @options.tls_root_certificates)
end

def test_override_host_name
assert_equal("", @options.override_host_name)
@options.override_host_name = "client.example.com"
assert_equal("client.example.com", @options.override_host_name)
end

def test_certificate_chain
assert_equal("", @options.certificate_chain)
@options.certificate_chain = "chain"
assert_equal("chain", @options.certificate_chain)
end

def test_private_key
assert_equal("", @options.private_key)
@options.private_key = "private"
assert_equal("private", @options.private_key)
end

def test_write_size_limit_bytes
assert_equal(0, @options.write_size_limit_bytes)
@options.write_size_limit_bytes = 100
assert_equal(100, @options.write_size_limit_bytes)
end

def test_disable_server_verifiation
assert do
not @options.disable_server_verification?
Expand Down

0 comments on commit f3010ba

Please sign in to comment.