jwtsigner_serv

Documentation

Index

• Variables
• type Server
  • func (s *Server) Main()
  • func (s *Server) Meta(ctx context.Context, in *jwtsigner_pb.MetaRequest) (*jwtsigner_pb.MetaResponse, error)
  • func (s *Server) PerformanceOpts()
  • func (s *Server) Run()
  • func (s *Server) RunServer()
  • func (s *Server) Sign(ctx context.Context, in *jwtsigner_pb.SignRequest) (*jwtsigner_pb.SignResponse, error)
  • func (s *Server) TLSOpts()

Variables

var Node = Server{
	App_Name:    "jwthelper_signerrpc",
	App_Version: "0.0.1",
	Address:     "0.0.0.0:5000",
	Log_Level:   "DEBUG",
	JtiGen_Name: "uuid4",
}

Types

type Server

type Server struct {
	App_Name    string `json:"app_name,omitempty" jsonschema:"required,description=服务名"`
	App_Version string `json:"app_version,omitempty" jsonschema:"description=服务版本"`
	Address     string `json:"address,omitempty" jsonschema:"required,description=服务的主机和端口"`
	Log_Level   string `` /* 132-byte string literal not displayed */

	// 性能设置
	Max_Recv_Msg_Size                           int  `json:"max_recv_msg_size,omitempty" jsonschema:"description=允许接收的最大消息长度"`
	Max_Send_Msg_Size                           int  `json:"max_send_msg_size,omitempty" jsonschema:"description=允许发送的最大消息长度"`
	Initial_Window_Size                         int  `json:"initial_window_size,omitempty" jsonschema:"description=基于Stream的滑动窗口大小"`
	Initial_Conn_Window_Size                    int  `json:"initial_conn_window_size,omitempty" jsonschema:"description=基于Connection的滑动窗口大小"`
	Max_Concurrent_Streams                      int  `json:"max_concurrent_streams,omitempty" jsonschema:"description=一个连接中最大并发Stream数"`
	Max_Connection_Idle                         int  `json:"max_connection_idle,omitempty" jsonschema:"description=客户端连接的最大空闲时长"`
	Max_Connection_Age                          int  `json:"max_connection_age,omitempty" jsonschema:"description=如果连接存活超过n则发送goaway"`
	Max_Connection_Age_Grace                    int  `json:"max_connection_age_grace,omitempty" jsonschema:"description=强制关闭连接之前允许等待的rpc在n秒内完成"`
	Keepalive_Time                              int  `json:"keepalive_time,omitempty" jsonschema:"description=空闲连接每隔n秒ping一次客户端已确保连接存活"`
	Keepalive_Timeout                           int  `json:"keepalive_timeout,omitempty" jsonschema:"description=ping时长超过n则认为连接已死"`
	Keepalive_Enforcement_Min_Time              int  `json:"keepalive_enforement_min_time,omitempty" jsonschema:"description=如果客户端超过每n秒ping一次则终止连接"`
	Keepalive_Enforcement_Permit_Without_Stream bool `json:"keepalive_enforement_permit_without_stream,omitempty" jsonschema:"description=即使没有活动流也允许ping"`

	//TLS设置
	Server_Cert_Path string `json:"server_cert_path,omitempty" jsonschema:"description=使用TLS时服务端的证书位置"`
	Server_Key_Path  string `json:"server_key_path,omitempty" jsonschema:"description=使用TLS时服务端证书的私钥位置"`
	Ca_Cert_Path     string `json:"ca_cert_path,omitempty" jsonschema:"description=使用TLS时根整数位置"`
	Client_Crl_Path  string `json:"client_crl_path,omitempty" jsonschema:"description=客户端证书黑名单位置"`

	//使用XDS
	XDS       bool `json:"xds,omitempty" jsonschema:"description=是否使用xDSAPIs"`
	XDS_CREDS bool `json:"xds_creds,omitempty" jsonschema:"description=是否使用xDSAPIs来接收TLS设置"`

	/**
	在这里补充其他配置项(注意去掉注释)
	*/
	Algo_Name                         string `` /* 182-byte string literal not displayed */
	Key_Path                          string `json:"key_path" jsonschema:"required,description=保存对称加密秘钥或者非对称加密私钥pem的文件位置"`
	Iss                               string `json:"iss,omitempty" jsonschema:"description=签发人默认为机器id-算法名"`
	Default_TTL_Minute                int    `json:"default_ttl_minute,omitempty" jsonschema:"description=默认token超时单位min"`
	Default_Effective_Interval_Minute int    `json:"default_effective_interval_minute,omitempty" jsonschema:"description=默认token生效离签发时间间隔单位min"`
	JtiGen_Name                       string `json:"jtigen_name,omitempty" jsonschema:"description=jti的生成器默认uuid4,enum=uuid4,enum=sonyflake"`

	jwtsigner_pb.UnimplementedJwtsignerServer `json:"-"`
	// contains filtered or unexported fields
}

Server grpc的服务器结构体 服务集成了如下特性: 设置收发最大消息长度 健康检测 gzip做消息压缩 接口反射 TLS支持 keep alive 支持

func (*Server) Main

func (s *Server) Main()

Main 服务的入口函数

func (*Server) Meta

func (s *Server) Meta(ctx context.Context, in *jwtsigner_pb.MetaRequest) (*jwtsigner_pb.MetaResponse, error)

Meta 查看签名器的元信息

func (*Server) PerformanceOpts

func (s *Server) PerformanceOpts()

PerformanceOpts 配置性能调优设置

func (*Server) Run

func (s *Server) Run()

Run 执行grpc服务

func (*Server) RunServer

func (s *Server) RunServer()

RunServer 启动服务

func (*Server) Sign

func (s *Server) Sign(ctx context.Context, in *jwtsigner_pb.SignRequest) (*jwtsigner_pb.SignResponse, error)

Sign 用签名器签名

func (*Server) TLSOpts

func (s *Server) TLSOpts()

TLSOpts 配置TLS设置