net.devh.boot.grpc.server.security.check

Class ManualGrpcSecurityMetadataSource

java.lang.Object

net.devh.boot.grpc.server.security.check.AbstractGrpcSecurityMetadataSource

net.devh.boot.grpc.server.security.check.ManualGrpcSecurityMetadataSource

All Implemented Interfaces:

GrpcSecurityMetadataSource, AopInfrastructureBean, SecurityMetadataSource

public final class ManualGrpcSecurityMetadataSource
extends AbstractGrpcSecurityMetadataSource

A GrpcSecurityMetadataSource for manual configuration. For each gRPC method a AccessPredicate can be defined, that checks whether the user is authenticated and has access. This metadata source only works if an AccessDecisionManager is configured with an AccessPredicateVoter.

Note: This instance is initialized with deny all as default.

Constructor Summary

Constructors

Constructor and Description
ManualGrpcSecurityMetadataSource()

Method Summary

Modifier and Type	Method and Description
Collection<ConfigAttribute>	getAllConfigAttributes()
Collection<ConfigAttribute>	getAttributes(io.grpc.ServerCall<?,?> call) Accesses the ConfigAttributes that apply to a given secure object.
ManualGrpcSecurityMetadataSource	remove(io.grpc.MethodDescriptor<?,?> method) Removes all access predicates for the given method.
ManualGrpcSecurityMetadataSource	remove(io.grpc.ServiceDescriptor service) Removes all access predicates for the all methods of the given service.
ManualGrpcSecurityMetadataSource	set(io.grpc.MethodDescriptor<?,?> method, AccessPredicate predicate) Set the given access predicate for the given method.
ManualGrpcSecurityMetadataSource	set(io.grpc.ServiceDescriptor service, AccessPredicate predicate) Set the given access predicate for the all methods of the given service.
ManualGrpcSecurityMetadataSource	setDefault(AccessPredicate predicate) Sets the default that will be used if no specific configuration has been made.

Methods inherited from class net.devh.boot.grpc.server.security.check.AbstractGrpcSecurityMetadataSource

getAttributes, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManualGrpcSecurityMetadataSource

public ManualGrpcSecurityMetadataSource()

Method Detail

getAttributes

public Collection<ConfigAttribute> getAttributes(io.grpc.ServerCall<?,?> call)

Description copied from interface: GrpcSecurityMetadataSource

Accesses the ConfigAttributes that apply to a given secure object.

Parameters:

call - The grpc call being secured.

Returns:

The attributes that apply to the passed in secured object. Should return an empty collection if there are no applicable attributes.

getAllConfigAttributes

public Collection<ConfigAttribute> getAllConfigAttributes()

set

public ManualGrpcSecurityMetadataSource set(io.grpc.ServiceDescriptor service,
                                            AccessPredicate predicate)

Set the given access predicate for the all methods of the given service. This will replace previously set predicates.

Parameters:

service - The service to protect with a custom check.

predicate - The predicate used to check the Authentication.

Returns:

This instance for chaining.

See Also:

setDefault(AccessPredicate)

remove

public ManualGrpcSecurityMetadataSource remove(io.grpc.ServiceDescriptor service)

Removes all access predicates for the all methods of the given service. After that, the default will be used for those methods.

Parameters:

service - The service to protect with only the default.

Returns:

This instance for chaining.

See Also:

setDefault(AccessPredicate)

set

public ManualGrpcSecurityMetadataSource set(io.grpc.MethodDescriptor<?,?> method,
                                            AccessPredicate predicate)

Set the given access predicate for the given method. This will replace previously set predicates.

Parameters:

method - The method to protect with a custom check.

predicate - The predicate used to check the Authentication.

Returns:

This instance for chaining.

See Also:

setDefault(AccessPredicate)

remove

public ManualGrpcSecurityMetadataSource remove(io.grpc.MethodDescriptor<?,?> method)

Removes all access predicates for the given method. After that, the default will be used for that method.

Parameters:

method - The method to protect with only the default.

Returns:

This instance for chaining.

See Also:

setDefault(AccessPredicate)

setDefault

public ManualGrpcSecurityMetadataSource setDefault(AccessPredicate predicate)

Sets the default that will be used if no specific configuration has been made.

Parameters:

predicate - The default predicate used to check the Authentication.

Returns:

This instance for chaining.