Skip to content

Commit 3e6b069

Browse files
letmaikeddyashton
authored andcommitted
Fix typo in README (#507)
* fix typo in README * Fix OpenEnclave/Open Enclave typo elsewhere * OpenEnOpen
1 parent fb6fe8f commit 3e6b069

File tree

9 files changed

+25
-25
lines changed

9 files changed

+25
-25
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ transactions in highly performant and highly available fashion.
4848

4949
## A flexible confidentiality layer for any multi-party computation application or blockchain ledger to build upon
5050

51-
CCF currently runs on [Intel SGX](https://software.intel.com/en-us/sgx)-enabled platforms. Because CCF uses the [OpenEnclave SDK](https://github.com/openenclave/openenclave)
52-
as the foundation for running in an enclave, as OpenEnclave supports new TEE technologies, CCF will be able to run on new platforms. Networks can be run on-premises,
51+
CCF currently runs on [Intel SGX](https://software.intel.com/en-us/sgx)-enabled platforms. Because CCF uses the [Open Enclave SDK](https://github.com/openenclave/openenclave)
52+
as the foundation for running in an enclave, as Open Enclave supports new TEE technologies, CCF will be able to run on new platforms. Networks can be run on-premises,
5353
in one or many cloud-hosted data centers, including [Microsoft Azure](https://azure.microsoft.com/), or in any hybrid configuration.
5454

5555
Ledger providers can use CCF to enable higher throughput and higher confidentiality guarantees for distributed ledger applications.

getting_started/setup_vm/roles/openenclave/tasks/install.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
- name: Include vars
22
include_vars: common.yml
33

4-
- name: Download OpenEnclave source
4+
- name: Download Open Enclave source
55
get_url:
66
url: "{{ oe_url }}"
77
dest: "{{ workspace }}/{{ oe_src }}"
88
force: yes
99
become: true
1010

11-
- name: Remove Pre-existing OpenEnclave source on the remote
11+
- name: Remove Pre-existing Open Enclave source on the remote
1212
file:
1313
path: "{{ workspace }}/openenclave-{{ oe_ver }}"
1414
state: absent
1515

16-
- name: Create directory for OpenEnclave source
16+
- name: Create directory for Open Enclave source
1717
file:
1818
path: "{{ workspace }}/openenclave-{{ oe_ver }}"
1919
state: directory
2020

21-
- name: Expand OpenEnclave
21+
- name: Expand Open Enclave
2222
unarchive:
2323
src: "{{ workspace }}/{{ oe_src }}"
2424
dest: "{{ workspace }}/openenclave-{{ oe_ver }}"
2525
copy: no
2626
extra_opts: [--strip-components=1]
2727
creates: "{{ workspace }}/openenclave-{{ oe_ver }}/CMakeLists.txt"
2828

29-
- name: Make OpenEnclave build dir
29+
- name: Make Open Enclave build dir
3030
file:
3131
path: "{{ workspace }}/openenclave-{{ oe_ver }}/build"
3232
state: directory
3333

34-
# OpenEnclave turns on the Clang speculative load hardening pass by default.
34+
# Open Enclave turns on the Clang speculative load hardening pass by default.
3535
# This is good practice for arbitrary enclaved code, as it applies a general
3636
# mitigation that does not depend on source code annotation. However, being
3737
# a general mitigation, it also carries about a 30% performance penalty when
@@ -45,7 +45,7 @@
4545
regexp: '-mllvm -x86-speculative-load-hardening'
4646
replace: ''
4747

48-
- name: Install OpenEnclave dependencies
48+
- name: Install Open Enclave dependencies
4949
shell: |
5050
scripts/ansible/install-ansible.sh
5151
ansible-playbook "{{ oe_playbook }}"
@@ -60,12 +60,12 @@
6060
name: ninja-build
6161
become: true
6262

63-
- name: Make OpenEnclave build dir
63+
- name: Make Open Enclave build dir
6464
file:
6565
path: "{{ workspace }}/openenclave-{{ oe_ver }}/build"
6666
state: directory
6767

68-
- name: Build OpenEnclave
68+
- name: Build Open Enclave
6969
shell: |
7070
cmake -GNinja -DCMAKE_INSTALL_PREFIX:PATH={{ oe_prefix }} -DCMAKE_BUILD_TYPE=RelWithDebInfo {{ oe_build_opts }} ..
7171
ninja
@@ -74,13 +74,13 @@
7474
async: 600
7575
poll: 5
7676

77-
- name: Remove Pre-existing OpenEnclave install
77+
- name: Remove Pre-existing Open Enclave install
7878
file:
7979
path: "{{ oe_prefix }}"
8080
state: absent
8181
become: true
8282

83-
- name: Install OpenEnclave
83+
- name: Install Open Enclave
8484
command: ninja install
8585
args:
8686
chdir: "{{ workspace }}/openenclave-{{ oe_ver }}/build"

sphinx/source/glossary.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Glossary
2424
Microsoft Azure
2525
`Microsoft Azure <https://azure.microsoft.com>`_ is a cloud computing service created by Microsoft for building, testing, deploying, and managing applications and services through Microsoft-managed data centers.
2626

27-
OpenEnclave
28-
`OpenEnclave SDK <https://openenclave.io/sdk>`_ is an SDK for building enclave applications in C and C++.
27+
Open Enclave
28+
`Open Enclave SDK <https://openenclave.io/sdk>`_ is an SDK for building enclave applications in C and C++.
2929

3030
Operators
3131
Are in charge of operating a CCF network (e.g. adding or removing nodes). Their identities are not registered in CCF.
3232

33-
OpenEnclave Engine
34-
`OpenEnclave Engine <https://github.com/Microsoft/oe-engine>`_ is a template generation tool for :term:`Azure Confidential Compute`.
33+
Open Enclave Engine
34+
`Open Enclave Engine <https://github.com/Microsoft/oe-engine>`_ is a template generation tool for :term:`Azure Confidential Compute`.
3535

3636
Quorum
3737
A quorum of members is defined as the minimum number of members required to accept governance proposals. It is defined by the governance as a Lua script set when a CCF network is created.

sphinx/source/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ transactions in highly performant and highly available fashion.
4848
A flexible confidentiality layer for multi-party computation
4949
------------------------------------------------------------
5050

51-
CCF currently runs on Intel :term:`SGX`-enabled platforms. Because CCF uses the :term:`OpenEnclave` SDK
52-
as the foundation for running in an enclave, as :term:`OpenEnclave` supports new TEE technologies, CCF will be able to run on new platforms. Networks can be run on-premises,
51+
CCF currently runs on Intel :term:`SGX`-enabled platforms. Because CCF uses the :term:`Open Enclave` SDK
52+
as the foundation for running in an enclave, as :term:`Open Enclave` supports new TEE technologies, CCF will be able to run on new platforms. Networks can be run on-premises,
5353
in one or many cloud-hosted data centers, including :term:`Microsoft Azure`, or in any hybrid configuration.
5454

5555
Ledger providers can use CCF to enable higher throughput and higher confidentiality guarantees for distributed ledger applications.

sphinx/source/members/common_member_operations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If the version of the code being executed needs to be updated (for example, to s
3434
3535
$ memberclient --cert member_cert --privk member_privk --rpc-address node_ip:node_port --ca network_cert add_code --new-code-id code_version
3636
37-
.. note:: For a given :term:`OpenEnclave` enclave library, the version of the code (``mrenclave``) can be found by running the ``oesign`` utility:
37+
.. note:: For a given :term:`Open Enclave` enclave library, the version of the code (``mrenclave``) can be found by running the ``oesign`` utility:
3838

3939
.. code-block:: bash
4040

sphinx/source/quickstart/build.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The full list of build switches can be obtained by running:
4646
* **CLIENT_MBEDTLS_PREFIX**: Path. Prefix to mbedtls install to be used by test clients. Default to ``/usr/local``.
4747
* **SERVICE_IDENTITY_CURVE_CHOICE**: String, one of ``secp384r1``, ``curve25519``, ``secp256k1_mbedtls``, ``secp256k1_bitcoin``. Elliptic curve to use for CCF network and node identities. Defaults to ``secp384r1``.
4848
* **NO_STRICT_TLS_CIPHERSUITES**: Boolean. Relax the list of accepted TLS ciphersuites. Default to OFF.
49-
* **OE_PREFIX**: Path. OpenEnclave install prefix. Default to ``/opt/openenclave``.
49+
* **OE_PREFIX**: Path. Open Enclave install prefix. Default to ``/opt/openenclave``.
5050
* **SAN**: Boolean. Build unit tests with Address and Undefined behaviour sanitizers enabled. Default to OFF.
5151
* **TARGET**: String, one of ``all``, ``sgx``, ``virtual``. Defaults to ``all``, which builds both "virtual" enclaves and actual SGX enclaves.
5252
* **VERBOSE_LOGGING**: Boolean. Enable all logging levels. Default to OFF.

sphinx/source/quickstart/oeengine.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
OE Engine Walkthrough
22
=====================
33

4-
:term:`OpenEnclave Engine` (OE Engine) offers detailed `deployment instructions`_, but this is a very condensed summary to get a CCF-ready VM up and running in 5 minutes. You can either execute these steps on a machine with the `Azure CLI`_ installed, or use `Azure Cloud Shell`_ (installed by the ``pre_make_vm.sh`` script).
4+
:term:`Open Enclave Engine` (OE Engine) offers detailed `deployment instructions`_, but this is a very condensed summary to get a CCF-ready VM up and running in 5 minutes. You can either execute these steps on a machine with the `Azure CLI`_ installed, or use `Azure Cloud Shell`_ (installed by the ``pre_make_vm.sh`` script).
55

66
1. Download the `oe-engine binary`_ for your platform.
77
2. Create a definition file as ``vm.json``:

sphinx/source/quickstart/requirements.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Azure Confidential Compute
4545

4646
.. note:: These steps require an `Azure subscription <https://docs.microsoft.com/en-us/azure/billing/billing-create-subscription#create-a-subscription-in-the-azure-portal>`_.
4747

48-
:term:`Azure Confidential Compute` (ACC) offers DC-series VMs using SGX hardware, which can be deployed either through a `Marketplace App`_, or through the :term:`OpenEnclave Engine`.
48+
:term:`Azure Confidential Compute` (ACC) offers DC-series VMs using SGX hardware, which can be deployed either through a `Marketplace App`_, or through the :term:`Open Enclave Engine`.
4949

5050
.. note:: On Windows, you can use `WSL <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ or `Azure Cloud Shell (Bash) <https://azure.microsoft.com/en-us/features/cloud-shell/>`_ to run the following commands.
5151

@@ -55,7 +55,7 @@ First, from your local machine, you should clone the CCF repository to get acces
5555
5656
$ git clone https://github.com/microsoft/CCF.git
5757
58-
First, you should run the ``pre_make_vm.sh`` script to install the `Azure CLI`_ and the :term:`OpenEnclave Engine` (``oe-engine``) that are required to create the DC-series in Azure:
58+
First, you should run the ``pre_make_vm.sh`` script to install the `Azure CLI`_ and the :term:`Open Enclave Engine` (``oe-engine``) that are required to create the DC-series in Azure:
5959

6060
.. code-block:: bash
6161

src/enclave/oe_shim.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
#else
1717

1818
// Repeat or approximate a lot of OE definitions, so that the virtual library
19-
// can be compiled without any reference to OpenEnclave. This may need updating
19+
// can be compiled without any reference to Open Enclave. This may need updating
2020
// to stay up-to-date with OE.
2121

2222
# define OE_EXTERNC extern "C"

0 commit comments

Comments
 (0)