Keybase client

Keybase Go库,客户端,服务,OS X,iOS,Android,Electron。「Keybase Go Library, Client, Service, OS X, iOS, Android, Electron」

Github stars Tracking Chart

Keybase 客户端

你好,欢迎来到 Keybase 客户端资源库,我们所有的客户端应用(macOS、Windows、Linux、iOS 和 Android)都是在这个仓库里积极开发的。请你四处看看吧。

警告

我们很希望你能阅读我们的源代码。

但是 -- 这个源码库中的一些东西是探索性的,你从源码中构建的应用可能不会像它所说的那样。所以,如果你只是想在你的电脑上安装 Keybase,你应该关注我们的 macOS、Linux 或 Windows 版本。

如果你对我们的 Docker 镜像发布感兴趣,请查看 the Docker README

代码布局

  • go:核心密码库; Keybase服务;命令行客户端。 了解更多
  • shared/{android,ios}:使用 React Native 开发的Android和iOS应用程序。
  • shared/desktop:用于 Electron 的macOS,Linux和Windows桌面应用程序框架,与react-native共享React代码。
  • packaging:跨各种平台发布软件包的脚本。
  • protocol:定义客户端与Keybase服务通信的协议。使用 Avro 了解更多
  • media:用于Keybase应用程序的图标,图形和媒体。
  • osx:macOS Keybase.app,与上述基于Electron的应用程序并行开发。 了解更多

有问题?

在这个 GitHub 问题跟踪器上报告客户端软件的任何问题。在内部,我们使用 Jira 跟踪我们的进度,但所有的 PR 都通过 GitHub 来供您审查!

如果您在使用命令行键库客户端时遇到问题,请查看故障排除文档

如果您在使用我们的网站时遇到问题,请尝试使用 keybase-issues 问题跟踪器。

我们经常检查和更新。

许可证

大多数代码是在新的BSD(3条款)许可下发布的。如果子目录 包括一个不同的许可证,该许可证适用。

开发指南

我们通过 pre-commit.com 生成的 pre-commit 钩子检查所有 git 提交。要使用这些预提交钩子,请注意以下几点:

  • 安装 pre-commit 实用程序。对于一些常见情况:
    • pip install pre-commit
    • brew install pre-commit
  • 通过 rm .git/hooks/pre-commit 删除任何现有的预先提交的钩子。
  • 通过 pre-commit install 配置

然后照常进行。

外部者贡献者

如果你在 GitHub 上派生了这个仓库并做了 PR,那么它会显示为 Jenkins CI 失败。我们不会建立外部 PR,因为在没有先进行审核的情况下,这样做是有安全风险的。如果你的 PR 被 Keybase 团队的成员成功审核,那么我们会将你的提交合并到我们的主分叉上的一个分支,然后从那里进行构建。

加密通知

本发行版包括加密软件。您目前居住的国家可能会对加密软件的进口、持有、使用和/或再出口到其他国家有限制。在使用任何加密软件之前,请检查您所在国家有关进口、持有或使用以及再出口加密软件的法律、法规和政策,以确定是否允许这样做。更多信息请参见 http://www.wassenaar.org/

美国政府商务部工业与安全局(BIS)已将该软件归类为出口商品控制号(ECCN)5D002.C.1,其中包括使用或执行非对称算法加密功能的信息安全软件。根据许可证例外ENC技术软件不受限制(TSU)的例外规定(见BIS出口管理条例第740.13节),这种分发的形式和方式使其有资格出口目标代码和源代码。


(The first version translated by vz on 2020.08.16)

Overview

Name With Ownergoogle/keyczar
Primary Language
Program languageShell (Language Count: 0)
PlatformAndroid, iOS, Linux, Mac, Windows
License:Apache License 2.0
Release Count16
Last Release NameJava_release_0.71j (Posted on )
First Release NameJava_release_0.71b (Posted on 2011-11-02 12:03:49)
Created At2015-03-07 21:41:04
Pushed At2019-05-14 02:29:29
Last Commit At2019-05-13 21:28:02
Stargazers Count1.1k
Watchers Count85
Fork Count141
Commits Count714
Has Issues Enabled
Issues Count179
Issue Open Count0
Pull Requests Count27
Pull Requests Open Count0
Pull Requests Close Count10
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private

Keybase Build Status Build status

Hi, and welcome to the Keybase client repo. All our client apps (macOS,
Windows, Linux, iOS, and Android) are being actively developed in this
repository. Please, dig around.

Warnings

We'd love you to read our source code.

But - some of the things in this repo are explorations, and the app you build
from source just might not do what it says it's doing. So, if you just want
to install Keybase on your computer, you should monitor our releases for macOS, Linux, or Windows.

Sharing

Code Layout

  • go: Core crypto libraries; the Keybase service; the command line client. Learn More
  • shared/{android,ios}: Android and iOS apps developed with React Native.
  • shared/desktop: Desktop application for macOS, Linux, and Windows, made with the Electron framework, sharing React code with react-native.
  • packaging: Scripts for releasing packages across the various platforms.
  • protocol: Defines the protocol for communication for clients to the Keybase services. Uses Avro. Learn More
  • media: Icons, graphics, media for Keybase apps.
  • osx: The macOS Keybase.app, development parallel to an Electron-based application above. Learn More

Problems?

Report any issues with client software on this GitHub
issue tracker.
Internally, we track our progress using Jira, but all PRs come through GitHub
for your review!

If you're having problems with the command line keybase client, take a
look at the troubleshooting doc.

If you're having problems with our Website, try the
keybase-issues issue tracker.

We check and update both frequently.

License

Most code is released under the New BSD (3 Clause) License. If subdirectories
include a different license, that license applies instead.

Development Guidelines

We check all git commits with pre-commit hooks generated via
pre-commit.com pre-commit hooks.
To enable use of these pre-commit hooks:

  • Install the pre-commit utility. For some common cases:
    • pip install pre-commit
    • brew install pre-commit
  • Remove any existing pre-commit hooks via rm .git/hooks/pre-commit
  • Configure via pre-commit install

Then proceed as normal.

External Contributors

If you forked this repository on GitHub and made a PR, then it'll show up as
having failed Jenkins CI. We do not build external PRs because it's a security
risk to do so without a review first. If your PR is successfully reviewed by a
member of the Keybase team, then we will merge your commits to a branch on our
primary fork and build from there.

Cryptography Notice

This distribution includes cryptographic software. The country in which you
currently reside may have restrictions on the import, possession, use, and/or
re-export to another country, of encryption software. BEFORE using any
encryption software, please check your country's laws, regulations and policies
concerning the import, possession, or use, and re-export of encryption
software, to see if this is permitted. See http://www.wassenaar.org/ for more
information.

The U.S. Government Department of Commerce, Bureau of Industry and Security
(BIS), has classified this software as Export Commodity Control Number (ECCN)
5D002.C.1, which includes information security software using or performing
cryptographic functions with asymmetric algorithms. The form and manner of this
distribution makes it eligible for export under the License Exception ENC
Technology Software Unrestricted (TSU) exception (see the BIS Export
Administration Regulations, Section 740.13) for both object code and source
code.

To the top