@lazycatcloud/sdk 0.1.152 → 0.1.154

package/dist/common/security_context.d.ts

@@ -0,0 +1,202 @@
+import { grpc } from "@improbable-eng/grpc-web";
+import _m0 from "protobufjs/minimal";
+export declare enum Permission {
+    /** USER_DOCUMENT - 是否允许挂载用户文档数据 */
+    USER_DOCUMENT = 0,
+    /** INSTALL_PACKAGE - 是否允许安装软件 */
+    INSTALL_PACKAGE = 1,
+    /** ACCESS_REMOVEABLE_STOREAGE - 是否允许挂载可移动存储设备 */
+    ACCESS_REMOVEABLE_STOREAGE = 2,
+    /** ACCESS_ENDDEVICE - 是否允许生成访问EndDevice的访问凭证, EndDevice会进行具体API的权限验证 */
+    ACCESS_ENDDEVICE = 1000,
+    ENDDEVICE_CLIPBOARD = 1001,
+    ENDDEVICE_NETWORK_INFO = 1002,
+    ENDDEVICE_PHOTOLIBRARY = 1003,
+    UNRECOGNIZED = -1
+}
+export declare function permissionFromJSON(object: any): Permission;
+export declare function permissionToJSON(object: Permission): string;
+export declare enum UserClass {
+    /** ANY_USER - 可以没有用户(比如一个纯后端app)或任何有效用户 */
+    ANY_USER = 0,
+    /** NORMAL_USER - 任何有效的用户 */
+    NORMAL_USER = 1,
+    /** ADMIN_USER - 必须是管理员用户 */
+    ADMIN_USER = 2,
+    /**
+     * TARGET_USER - 请求者必须是资源所有者对应的用户，比如"设置密码"每个用户都有权设置，但仅能设置自身的
+     * 具体的TARGET_USER通过input message中的target_uid_field option进行标记
+     */
+    TARGET_USER = 3,
+    UNRECOGNIZED = -1
+}
+export declare function userClassFromJSON(object: any): UserClass;
+export declare function userClassToJSON(object: UserClass): string;
+export declare enum SecurityContextMetaKey {
+    META_KEY_X_LZCAPI_APPID = 0,
+    META_KEY_X_LZCAPI_REALUID = 1,
+    META_KEY_X_LZCAPI_UID = 2,
+    UNRECOGNIZED = -1
+}
+export declare function securityContextMetaKeyFromJSON(object: any): SecurityContextMetaKey;
+export declare function securityContextMetaKeyToJSON(object: SecurityContextMetaKey): string;
+/** APIGateway在进行完权限检测放行后，转发给API Services时会通过metadata附带以下信息 */
+export interface SecurityContext {
+    /** 请求来源的真实appid，一定是合法有效的 */
+    appid: string;
+    /** 请求来源的真实uid,一定是合法有效的 */
+    realUid: string;
+    /**
+     * 请求来源期望的uid，注意此值可以被app server篡改
+     * 若uid != real_uid且对应SecurityContextRequire.disable_behalf_of_uid == true
+     * 则此请求会被APIGATEWAY阻止转发
+     * 若app server没有篡改此值，则此值与real_uid相同
+     */
+    uid: string;
+}
+/**
+ * 以下权限要求通过option的方式声明在proto文件内
+ * 并由APIGateway进行验证
+ */
+export interface SecurityContextRequire {
+    requirePermissions: Permission[];
+    requireUserClass: UserClass;
+    /** 请求必须直接通过app server发起，而非serverless端发起 */
+    requireFromBackend: boolean;
+    /** 禁止app server伪造uid */
+    disableBehalfOfUid: boolean;
+}
+export interface PermissionDesc {
+    /** 申请权限的原因说明 */
+    reason: string;
+    /** 权限列表 */
+    permissions: Permission[];
+}
+/** 后续调用lzc-apis时，需要带上此token */
+export interface PermissionToken {
+    token: string;
+}
+export interface PermissionStatus {
+}
+export interface HasPermissionRequest {
+    perm: Permission;
+}
+export declare const SecurityContext: {
+    encode(message: SecurityContext, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): SecurityContext;
+    fromJSON(object: any): SecurityContext;
+    toJSON(message: SecurityContext): unknown;
+    fromPartial<I extends {
+        appid?: string;
+        realUid?: string;
+        uid?: string;
+    } & {
+        appid?: string;
+        realUid?: string;
+        uid?: string;
+    } & { [K in Exclude<keyof I, keyof SecurityContext>]: never; }>(object: I): SecurityContext;
+};
+export declare const SecurityContextRequire: {
+    encode(message: SecurityContextRequire, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): SecurityContextRequire;
+    fromJSON(object: any): SecurityContextRequire;
+    toJSON(message: SecurityContextRequire): unknown;
+    fromPartial<I extends {
+        requirePermissions?: Permission[];
+        requireUserClass?: UserClass;
+        requireFromBackend?: boolean;
+        disableBehalfOfUid?: boolean;
+    } & {
+        requirePermissions?: Permission[] & Permission[] & { [K in Exclude<keyof I["requirePermissions"], keyof Permission[]>]: never; };
+        requireUserClass?: UserClass;
+        requireFromBackend?: boolean;
+        disableBehalfOfUid?: boolean;
+    } & { [K_1 in Exclude<keyof I, keyof SecurityContextRequire>]: never; }>(object: I): SecurityContextRequire;
+};
+export declare const PermissionDesc: {
+    encode(message: PermissionDesc, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PermissionDesc;
+    fromJSON(object: any): PermissionDesc;
+    toJSON(message: PermissionDesc): unknown;
+    fromPartial<I extends {
+        reason?: string;
+        permissions?: Permission[];
+    } & {
+        reason?: string;
+        permissions?: Permission[] & Permission[] & { [K in Exclude<keyof I["permissions"], keyof Permission[]>]: never; };
+    } & { [K_1 in Exclude<keyof I, keyof PermissionDesc>]: never; }>(object: I): PermissionDesc;
+};
+export declare const PermissionToken: {
+    encode(message: PermissionToken, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PermissionToken;
+    fromJSON(object: any): PermissionToken;
+    toJSON(message: PermissionToken): unknown;
+    fromPartial<I extends {
+        token?: string;
+    } & {
+        token?: string;
+    } & { [K in Exclude<keyof I, "token">]: never; }>(object: I): PermissionToken;
+};
+export declare const PermissionStatus: {
+    encode(_: PermissionStatus, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PermissionStatus;
+    fromJSON(_: any): PermissionStatus;
+    toJSON(_: PermissionStatus): unknown;
+    fromPartial<I extends {} & {} & { [K in Exclude<keyof I, never>]: never; }>(_: I): PermissionStatus;
+};
+export declare const HasPermissionRequest: {
+    encode(message: HasPermissionRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): HasPermissionRequest;
+    fromJSON(object: any): HasPermissionRequest;
+    toJSON(message: HasPermissionRequest): unknown;
+    fromPartial<I extends {
+        perm?: Permission;
+    } & {
+        perm?: Permission;
+    } & { [K in Exclude<keyof I, "perm">]: never; }>(object: I): HasPermissionRequest;
+};
+export interface PermissionManager {
+    Request(request: DeepPartial<PermissionDesc>, metadata?: grpc.Metadata): Promise<PermissionToken>;
+    Has(request: DeepPartial<HasPermissionRequest>, metadata?: grpc.Metadata): Promise<PermissionStatus>;
+}
+export declare class PermissionManagerClientImpl implements PermissionManager {
+    private readonly rpc;
+    constructor(rpc: Rpc);
+    Request(request: DeepPartial<PermissionDesc>, metadata?: grpc.Metadata): Promise<PermissionToken>;
+    Has(request: DeepPartial<HasPermissionRequest>, metadata?: grpc.Metadata): Promise<PermissionStatus>;
+}
+export declare const PermissionManagerDesc: {
+    serviceName: string;
+};
+export declare const PermissionManagerRequestDesc: UnaryMethodDefinitionish;
+export declare const PermissionManagerHasDesc: UnaryMethodDefinitionish;
+interface UnaryMethodDefinitionishR extends grpc.UnaryMethodDefinition<any, any> {
+    requestStream: any;
+    responseStream: any;
+}
+declare type UnaryMethodDefinitionish = UnaryMethodDefinitionishR;
+interface Rpc {
+    unary<T extends UnaryMethodDefinitionish>(methodDesc: T, request: any, metadata: grpc.Metadata | undefined): Promise<any>;
+}
+export declare class GrpcWebImpl {
+    private host;
+    private options;
+    constructor(host: string, options: {
+        transport?: grpc.TransportFactory;
+        debug?: boolean;
+        metadata?: grpc.Metadata;
+        upStreamRetryCodes?: number[];
+    });
+    unary<T extends UnaryMethodDefinitionish>(methodDesc: T, _request: any, metadata: grpc.Metadata | undefined): Promise<any>;
+}
+declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export declare class GrpcWebError extends Error {
+    code: grpc.Code;
+    metadata: grpc.Metadata;
+    constructor(message: string, code: grpc.Code, metadata: grpc.Metadata);
+}
+export {};
+//# sourceMappingURL=security_context.d.ts.map

package/dist/common/security_context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"security_context.d.ts","sourceRoot":"","sources":["../../common/security_context.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAEhD,OAAO,GAAG,MAAM,oBAAoB,CAAC;AAErC,oBAAY,UAAU;IACpB,mCAAmC;IACnC,aAAa,IAAI;IACjB,iCAAiC;IACjC,eAAe,IAAI;IACnB,iDAAiD;IACjD,0BAA0B,IAAI;IAC9B,wEAAwE;IACxE,gBAAgB,OAAO;IACvB,mBAAmB,OAAO;IAC1B,sBAAsB,OAAO;IAC7B,sBAAsB,OAAO;IAC7B,YAAY,KAAK;CAClB;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,GAAG,GAAG,UAAU,CA4B1D;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAoB3D;AAED,oBAAY,SAAS;IACnB,2CAA2C;IAC3C,QAAQ,IAAI;IACZ,4BAA4B;IAC5B,WAAW,IAAI;IACf,4BAA4B;IAC5B,UAAU,IAAI;IACd;;;OAGG;IACH,WAAW,IAAI;IACf,YAAY,KAAK;CAClB;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,GAAG,GAAG,SAAS,CAmBxD;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAczD;AAED,oBAAY,sBAAsB;IAChC,uBAAuB,IAAI;IAC3B,yBAAyB,IAAI;IAC7B,qBAAqB,IAAI;IACzB,YAAY,KAAK;CAClB;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,GAAG,GAAG,sBAAsB,CAgBlF;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,sBAAsB,GAAG,MAAM,CAYnF;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,kBAAkB,EAAE,UAAU,EAAE,CAAC;IACjC,gBAAgB,EAAE,SAAS,CAAC;IAC5B,2CAA2C;IAC3C,kBAAkB,EAAE,OAAO,CAAC;IAC5B,wBAAwB;IACxB,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,gBAAgB;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW;IACX,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,+BAA+B;AAC/B,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAC;CAClB;AAMD,eAAO,MAAM,eAAe;oBACV,eAAe,WAAU,IAAI,MAAM,GAAyB,IAAI,MAAM;kBAaxE,IAAI,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,eAAe;qBAwBvD,GAAG,GAAG,eAAe;oBAQtB,eAAe,GAAG,OAAO;;gBA9FlC,MAAM;kBAEJ,MAAM;cAOV,MAAM;;gBATJ,MAAM;kBAEJ,MAAM;cAOV,MAAM;gFA6F+D,eAAe;CAO1F,CAAC;AAMF,eAAO,MAAM,sBAAsB;oBACjB,sBAAsB,WAAU,IAAI,MAAM,GAAyB,IAAI,MAAM;kBAkB/E,IAAI,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,sBAAsB;qBAkC9D,GAAG,GAAG,sBAAsB;oBAW7B,sBAAsB,GAAG,OAAO;;;2BAjK9B,SAAS;6BAEP,OAAO;6BAEP,OAAO;;;2BAJT,SAAS;6BAEP,OAAO;6BAEP,OAAO;yFA0KsD,sBAAsB;CAQxG,CAAC;AAMF,eAAO,MAAM,cAAc;oBACT,cAAc,WAAU,IAAI,MAAM,GAAyB,IAAI,MAAM;kBAYvE,IAAI,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,cAAc;qBA4BtD,GAAG,GAAG,cAAc;oBAOrB,cAAc,GAAG,OAAO;;iBAnOhC,MAAM;;;iBAAN,MAAM;;iFA8O2D,cAAc;CAMxF,CAAC;AAMF,eAAO,MAAM,eAAe;oBACV,eAAe,WAAU,IAAI,MAAM,GAAyB,IAAI,MAAM;kBAOxE,IAAI,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,eAAe;qBAkBvD,GAAG,GAAG,eAAe;oBAItB,eAAe,GAAG,OAAO;;gBAjRlC,MAAM;;gBAAN,MAAM;kEAuR6D,eAAe;CAK1F,CAAC;AAMF,eAAO,MAAM,gBAAgB;cACjB,gBAAgB,WAAU,IAAI,MAAM,GAAyB,IAAI,MAAM;kBAInE,IAAI,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,gBAAgB;gBAe7D,GAAG,GAAG,gBAAgB;cAIxB,gBAAgB,GAAG,OAAO;uFAKkC,gBAAgB;CAIvF,CAAC;AAMF,eAAO,MAAM,oBAAoB;oBACf,oBAAoB,WAAU,IAAI,MAAM,GAAyB,IAAI,MAAM;kBAO7E,IAAI,MAAM,GAAG,UAAU,WAAW,MAAM,GAAG,oBAAoB;qBAkB5D,GAAG,GAAG,oBAAoB;oBAI3B,oBAAoB,GAAG,OAAO;;eAhWxC,UAAU;;eAAV,UAAU;iEAsW+D,oBAAoB;CAKpG,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAClG,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACtG;AAED,qBAAa,2BAA4B,YAAW,iBAAiB;IACnE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;gBAEd,GAAG,EAAE,GAAG;IAMpB,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,eAAe,CAAC;IAIjG,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGrG;AAED,eAAO,MAAM,qBAAqB;;CAAiE,CAAC;AAEpG,eAAO,MAAM,4BAA4B,EAAE,wBAoB1C,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,wBAoBtC,CAAC;AAEF,UAAU,yBAA0B,SAAQ,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC;IAC9E,aAAa,EAAE,GAAG,CAAC;IACnB,cAAc,EAAE,GAAG,CAAC;CACrB;AAED,aAAK,wBAAwB,GAAG,yBAAyB,CAAC;AAE1D,UAAU,GAAG;IACX,KAAK,CAAC,CAAC,SAAS,wBAAwB,EACtC,UAAU,EAAE,CAAC,EACb,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,SAAS,GAClC,OAAO,CAAC,GAAG,CAAC,CAAC;CACjB;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,OAAO,CAMb;gBAGA,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QACP,SAAS,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC;QAElC,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;QACzB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;KAC/B;IAMH,KAAK,CAAC,CAAC,SAAS,wBAAwB,EACtC,UAAU,EAAE,CAAC,EACb,QAAQ,EAAE,GAAG,EACb,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,SAAS,GAClC,OAAO,CAAC,GAAG,CAAC;CAuBhB;AAED,aAAK,OAAO,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpF,aAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GACvC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACnH,CAAC,SAAS,EAAE,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACrD,OAAO,CAAC,CAAC,CAAC,CAAC;AAUf,qBAAa,YAAa,SAAQ,KAAK;IACD,IAAI,EAAE,IAAI,CAAC,IAAI;IAAS,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBAAvE,OAAO,EAAE,MAAM,EAAS,IAAI,EAAE,IAAI,CAAC,IAAI,EAAS,QAAQ,EAAE,IAAI,CAAC,QAAQ;CAGpF"}