Skip to content

Commit

Permalink
server-nodejs demo/update
Browse files Browse the repository at this point in the history
  • Loading branch information
mayism committed Nov 27, 2021
1 parent 745ee16 commit 475d4f1
Show file tree
Hide file tree
Showing 18 changed files with 776 additions and 0 deletions.
53 changes: 53 additions & 0 deletions authservice/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
49 changes: 49 additions & 0 deletions authservice/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## Auth-server quickstart

English | [ÖÐÎÄ](./README_ZH.md)

## Table of Contents

* [Introduction](#introduction)
* [Preparing the Environments](#preparing-the-environments)
* [Getting Started](#getting-started)
* [Sample Code](#sample-Code)
* [Result](#result)
* [Question or issues](#question-or-issues)
* [License](#license)

## Introduction
Most apps need to identify and authenticate users to tailor the app experience for individual users. However, building such a system from scratch is a difficult process. Auth Service can quickly build a secure and reliable user authentication system for your app. You only need to access Auth Service capabilities in your app without caring about the facilities and implementation on the cloud.

## Preparing the Environments
* Before using the auth server sdk, your server needs support Node.js v10.12.0 and higher.

## Getting Started
Before running the auth server sdk, you need to:
1. If you do not have a HUAWEI Developer account, you need to [register an account](https://developer.huawei.com/consumer/en/doc/start/registration-and-verification-0000001053628148) and pass identity verification.
2. Use your account to sign in to [AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html#/), create a project.
3. Go to Project settings > Server SDK, click Create under API client, then click Download credential.
4. Save the downloaded authentication credential file agc-apiclient-xxx-xxx.json to the specified path. The file will be used during SDK initialization in [index.js](./index.js).
5. Run the following code in terminal in the demo path, and demo will start.
``` bash
# install AGC auth-server sdk
npm install --save @agconnect/[email protected]
# run demo
npm run build
```
5. More details about [Auth-Server](https://developer.huawei.com/consumer/en/doc/development/AppGallery-connect-Guides/agc-get-started-server-0000001058092593#section1778162811430)

## Sample Code

Sample code: index.js

## Question or issues

If you have questions about how to use AppGallery Connect Demos, try the following options:
* [Stack Overflow](https://stackoverflow.com/) is the best place for any programming questions. Be sure to tag your question with `AppGallery`.
* [Huawei Developer Forum](https://forums.developer.huawei.com/forumPortal/en/home) AppGallery Module is great for general questions, or seeking recommendations and opinions.

If you run into a bug in our samples, please submit an [issue](https://github.com/AppGalleryConnect/agc-demos/issues) to the Repository. Even better you can submit a [Pull Request](https://github.com/AppGalleryConnect/agc-demos/pulls) with a fix.

## License
This quickstart is licensed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
48 changes: 48 additions & 0 deletions authservice/README_ZH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## Auth-server 快速入门

中文 | [English](./README.md)

## 目录

* [简介](#简介)
* [环境要求](#环境要求)
* [快速入门](#快速入门)
* [示例代码](#示例代码)
* [技术支持](#技术支持)
* [授权许可](#授权许可)

## 简介
大部分的应用都需要对用户的业务访问进行身份认证,以便为用户提供个性化体验。但是端到端完整构建一套用户认证系统会面临很多挑战。认证服务可以为您的应用快速构建安全可靠的用户认证系统,您只需在应用中访问认证服务的相关能力,而不需要关心云侧的设施和实现。

## 环境要求
* Node.js v10.12.0及以上环境

## 快速入门
在运行quickstart前,您需要
1. 如果没有华为开发者联盟帐号,需要先[注册账号](https://developer.huawei.com/consumer/cn/doc/start/registration-and-verification-0000001053628148) 并通过实名认证。
2. 使用申请的帐号登录[AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html#/) 网站创建一个项目。
3. 在“项目设置”页面中点击“Server SDK”页签,点击认证凭据中的“创建”,创建完后生成认证凭据,点击“下载认证凭据”。
4. 将下载后的认证凭据文件agc-apiclient-*.json放置到您指定路径下,在[index.js](./index.js)中初始化SDK时将会使用到该文件.
5. 在命令行中依次运行如下命令以运行demo:
``` bash
# 安装 AGC auth-server sdk
npm install --save @agconnect/[email protected]
# 启动demo
npm run build
```
5. More details about [Auth-Server](https://developer.huawei.com/consumer/en/doc/development/AppGallery-connect-Guides/agc-get-started-server-0000001058092593#section1778162811430)

## 示例代码

Sample code: index.js

## 技术支持

如果您对使用AppGallery Connect示例代码有疑问,请通过如下途径寻求帮助:
- 访问[Stack Overflow](https://stackoverflow.com/) , 在`AppGallery`标签下提问,有华为研发专家在线一对一解决您的问题。
- 访问[华为开发者论坛](https://forums.developer.huawei.com/forumPortal/en/home) AppGallery Connect板块与其他开发者进行交流。

如果您在尝试示例代码中遇到问题,请向仓库提交[issue](https://github.com/AppGalleryConnect/agc-demos/issues) ,也欢迎您提交[Pull Request](https://github.com/AppGalleryConnect/agc-demos/pulls) 。

## 授权许可
该示例代码经过[Apache 2.0 授权许可](http://www.apache.org/licenses/LICENSE-2.0) 。
79 changes: 79 additions & 0 deletions authservice/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/*
* Copyright 2021. Huawei Technologies Co., Ltd. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

var {AGCClient, CredentialParser} = require("@agconnect/common-server");
var {AGCAuth} = require("@agconnect/auth-server");

var credential = CredentialParser.toCredential("[PATH]/agc-apiclient-xxx-xxx.json");
var yourClientName = "abc";
AGCClient.initialize(credential, yourClientName, "CN");

var authService = AGCAuth.getInstance(yourClientName);

/**
* get privateKey and publicKey
*/
var keyPair = authService.generateKey();
console.log("privateKey:", keyPair.getPrivateKey());
console.log("privateKey:", keyPair.getPublicKey());

/**
* do sign and get jwt
*/
var jwt = authService.sign("uid", "userName", "url", keyPair.getPrivateKey());
console.log("generate jwt:", jwt.getToken());
console.log("generate jwt expiration time:", jwt.getExpirationTime());

/**
* export user info to file:[PATH]/xxx.json
*/
authService.exportUserData("[PATH]/xxx.json").then(res => {
console.info("export success count:", res.getSuccessCount());
console.info("export success count:", res.getErrorUsers());
console.info("export fail uid detail:", res.getErrorUsersList());
}).catch(e => {
console.error(e.message);
})

/**
* import user from file:[PATH]/yyy.json
*/
authService.importUserData("[PATH]/yyy.json").then(res => {
console.info("import success count:", res.getSuccessCount());
console.info("import success count:", res.getErrorUsers());
console.info("import fail uid detail:", res.getErrorUsersList());
}).catch(e => {
console.error(e.message);
})

/**
* verify access token
*/
authService.verifyAccessToken("your access token", true).then(res => {
console.info("verify ok, uid is:", res.getAud());
// get user info from AuthAccessToken object, include name/picture/phone/email and so on
}).catch(e => {
console.error(e.message);
})

/**
* revoke token of uid:a uid
*/
authService.revokeRefreshTokens("a uid").then(() => {
console.info("revoke success");
}).catch(e => {
console.error(e.message);
})
23 changes: 23 additions & 0 deletions authservice/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "server-demo",
"version": "1.0.0",
"description": "AppGallery Connect Server-SDK demo for Node.js auth module",
"main": "index.js",
"scripts": {
"build": "node index.js"
},
"author": {
"name": "AppGallery Connect",
"url": "https://developer.huawei.com/consumer/cn/service/josp/agc/index.html#/"
},
"license": "Apache-2.0",
"keywords": [
"agconnect",
"Node.js",
"server SDK",
"authentication",
"demo"
],
"dependencies": {
}
}
3 changes: 3 additions & 0 deletions clouddb/.idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions clouddb/.idea/agc-clouddb-demo-javascript.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions clouddb/.idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions clouddb/.idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions clouddb/.idea/runConfigurations.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions clouddb/.idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions clouddb/CloudDBQuickStart_1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"schemaVersion":1,"permissions":[{"permissions":[{"role":"World","rights":["Read"]},{"role":"Authenticated","rights":["Read"]},{"role":"Creator","rights":["Read","Upsert","Delete"]},{"role":"Administrator","rights":["Read","Upsert","Delete"]}],"objectTypeName":"BookInfo"}],"objectTypes":[{"indexes":[{"indexName":"queryIndex","indexList":["bookName","price","id"]},{"indexName":"bookName","indexList":["bookName"]}],"objectTypeName":"BookInfo","fields":[{"isNeedEncrypt":false,"fieldName":"id","notNull":true,"belongPrimaryKey":true,"fieldType":"Integer"},{"isNeedEncrypt":false,"fieldName":"bookName","notNull":false,"belongPrimaryKey":false,"fieldType":"String"},{"isNeedEncrypt":false,"fieldName":"author","notNull":false,"belongPrimaryKey":false,"fieldType":"String"},{"isNeedEncrypt":false,"fieldName":"price","notNull":false,"belongPrimaryKey":false,"fieldType":"Double"},{"isNeedEncrypt":false,"fieldName":"publisher","notNull":false,"belongPrimaryKey":false,"fieldType":"String"},{"isNeedEncrypt":false,"fieldName":"publishTime","notNull":false,"belongPrimaryKey":false,"fieldType":"Date"}]}]}
Loading

0 comments on commit 475d4f1

Please sign in to comment.