import ballerina/grpc;
listener grpc:Listener securedEP = new(9090,
secureSocket = {
key: {
certFile: "../resource/path/to/public.crt",
keyFile: "../resource/path/to/private.key"
}
}
);
// The service can be secured with Basic auth and can be authorized optionally.
// Basic auth using the LDAP user store can be enabled by setting the
// [`grpc:LdapUserStoreConfig`](https://docs.central.ballerina.io/ballerina/grpc/latest/records/LdapUserStoreConfig) configurations.
// Authorization is based on scopes. A scope maps to one or more groups.
// Authorization can be enabled by setting the `string|string[]` type
// configurations for `scopes` field.
@grpc:ServiceConfig {
auth: [
{
ldapUserStoreConfig: {
domainName: "avix.lk",
connectionUrl: "ldap://localhost:389",
connectionName: "cn=admin,dc=avix,dc=lk",
connectionPassword: "avix123",
userSearchBase: "ou=Users,dc=avix,dc=lk",
userEntryObjectClass: "inetOrgPerson",
userNameAttribute: "uid",
userNameSearchFilter: "(&(objectClass=inetOrgPerson)(uid=?))",
userNameListFilter: "(objectClass=inetOrgPerson)",
groupSearchBase: ["ou=Groups,dc=avix,dc=lk"],
groupEntryObjectClass: "groupOfNames",
groupNameAttribute: "cn",
groupNameSearchFilter: "(&(objectClass=groupOfNames)(cn=?))",
groupNameListFilter: "(objectClass=groupOfNames)",
membershipAttribute: "member",
userRolesCacheEnabled: true,
connectionPoolingEnabled: false,
connectionTimeout: 5,
readTimeout: 60
},
scopes: ["admin"]
}
]
}
@grpc:ServiceDescriptor {
descriptor: ROOT_DESCRIPTOR_GRPC_SERVICE,
descMap: getDescriptorMapGrpcService()
}
service "HelloWorld" on securedEP {
remote function hello() returns string {
return "Hello, World!";
}
}
Service - Basic Auth LDAP user storeA gRPC service/resource can be secured using Basic auth and by enforcing
authorization optionally. Then, it validates the Basic auth token sent in
the |
syntax = "proto3";
import "google/protobuf/empty.proto";
import "google/protobuf/wrappers.proto";
This is the service definition for the scenario.
service HelloWorld {
rpc hello(google.protobuf.Empty) returns (google.protobuf.StringValue);
}
# Create a new Protocol Buffers definition file named `grpc_service.proto` and add the service definition to it.
# Run the command below in the Ballerina tools distribution for stub generation.
bal grpc --input grpc_service.proto --output stubs
# Once you run the command, `grpc_service_pb.bal` file is generated inside stubs directory.
# For more information on how to use the Ballerina Protocol Buffers tool, see the [Proto To Ballerina](https://ballerina.io/learn/by-example/proto-to-ballerina.html) example.
import ballerina/grpc;
listener grpc:Listener securedEP = new(9090,
secureSocket = {
key: {
certFile: "../resource/path/to/public.crt",
keyFile: "../resource/path/to/private.key"
}
}
);
@grpc:ServiceConfig {
auth: [
{
ldapUserStoreConfig: {
domainName: "avix.lk",
connectionUrl: "ldap://localhost:389",
connectionName: "cn=admin,dc=avix,dc=lk",
connectionPassword: "avix123",
userSearchBase: "ou=Users,dc=avix,dc=lk",
userEntryObjectClass: "inetOrgPerson",
userNameAttribute: "uid",
userNameSearchFilter: "(&(objectClass=inetOrgPerson)(uid=?))",
userNameListFilter: "(objectClass=inetOrgPerson)",
groupSearchBase: ["ou=Groups,dc=avix,dc=lk"],
groupEntryObjectClass: "groupOfNames",
groupNameAttribute: "cn",
groupNameSearchFilter: "(&(objectClass=groupOfNames)(cn=?))",
groupNameListFilter: "(objectClass=groupOfNames)",
membershipAttribute: "member",
userRolesCacheEnabled: true,
connectionPoolingEnabled: false,
connectionTimeout: 5,
readTimeout: 60
},
scopes: ["admin"]
}
]
}
@grpc:ServiceDescriptor {
descriptor: ROOT_DESCRIPTOR_GRPC_SERVICE,
descMap: getDescriptorMapGrpcService()
}
service "HelloWorld" on securedEP {
remote function hello() returns string {
return "Hello, World!";
}
}
The service can be secured with Basic auth and can be authorized optionally.
Basic auth using the LDAP user store can be enabled by setting the
grpc:LdapUserStoreConfig
configurations.
Authorization is based on scopes. A scope maps to one or more groups.
Authorization can be enabled by setting the string|string[]
type
configurations for scopes
field.
# Create a Ballerina package.
# Copy the generated `grpc_secured_pb.bal` stub file to the package.
# For example, if you create a package named `service`, copy the stub file to the `service` package.
# Create a new `grpc_service_basic_auth_ldap_user_store.bal` Ballerina file inside the `service` package and add the service implementation.
# Execute the command below to build the 'service' package.
# You may need to change the certificate file path and private key file path.
`bal build service`
# Run the service using the command below.
bal run service/target/bin/service.jar