Skip to content

Commit aa02c2f

Browse files
Move Security Encyclopedia Sections (#1580)
* move securing web-based projects * routes * move signatures section * links * another link * routes * more routes * redirects * Update nginx/includes/redirects.conf Co-authored-by: Elliot Voris <elliot@stellar.org> * fix more redirects --------- Co-authored-by: Elliot Voris <elliot@stellar.org>
1 parent bf17e6f commit aa02c2f

17 files changed

Lines changed: 31 additions & 35 deletions

File tree

docs/build/apps/application-design-considerations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are four custody options to consider:
1111

1212
- Non-custodial service - the user of the application stores their own secret key
1313
- Custodial service - the service provider (application) stores the users’ secret keys
14-
- Mixture of both - with the use of [multisig](../../learn/encyclopedia/security/signatures-multisig.mdx), this option is useful for maintaining non-custodial status while still allowing for account recovery
14+
- Mixture of both - with the use of [multisig](../../learn/fundamentals/transactions/signatures-multisig.mdx), this option is useful for maintaining non-custodial status while still allowing for account recovery
1515
- Third-party key management services - integrate a third-party custodial service into your application that can store your users’ secret keys
1616

1717
### Non-custodial service
@@ -28,7 +28,7 @@ Many custodial services choose to use a single pooled Stellar account (called sh
2828

2929
### A mixture of non-custodial and custodial
3030

31-
Building an application with [multi-signature](../../learn/encyclopedia/security/signatures-multisig.mdx) capabilities allows you to have a non-custodial service with account recovery. If the user loses their secret key, they can still sign transactions with other authorized signatures, granted the signature threshold is high enough.
31+
Building an application with [multi-signature](../../learn/fundamentals/transactions/signatures-multisig.mdx) capabilities allows you to have a non-custodial service with account recovery. If the user loses their secret key, they can still sign transactions with other authorized signatures, granted the signature threshold is high enough.
3232

3333
### Third-party key management services​
3434

docs/build/apps/wallet/sep30.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ let recoverableWallet = try await recovery.createRecoverableWallet(config: confi
233233
With the given parameters, this function will create a transaction that will:
234234

235235
1. Set `deviceKp` as the primary account key. Please note that the master key belonging to `accountKp` will be locked. `deviceKp` should be used as a primary signer instead.
236-
2. Set all operation thresholds to 10. You can read more about threshold in the [documentation](../../../learn/encyclopedia/security/signatures-multisig.mdx#thresholds)
236+
2. Set all operation thresholds to 10. You can read more about threshold in the [documentation](../../../learn/fundamentals/transactions/signatures-multisig.mdx#thresholds)
237237
3. Use identities that were defined earlier on both servers. (That means, both server will accept SEP-10 authentication via `recoveryKp` as an auth method)
238238
4. Set device key weight to 10, and recovery server weight to 5. Given these account thresholds, both servers must be used to recover the account, as transaction signed by one will only have weight of 5, which is not sufficient to change account key.
239239

docs/build/guides/tokens/custom-sac-admin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The following example will create a new Stellar asset, `STAR:GCS5NEHKJALCSVJAKIO
3939

4040
:::note
4141

42-
We will not demonstrate setting a new `G...` account as a SAC admin in this guide. Any use-case that needs asset administration delegated to another `G...` account will likely be better served by taking advantage of the existing [multisig capabilities](../../../learn/encyclopedia/security/signatures-multisig.mdx) of Stellar accounts.
42+
We will not demonstrate setting a new `G...` account as a SAC admin in this guide. Any use-case that needs asset administration delegated to another `G...` account will likely be better served by taking advantage of the existing [multisig capabilities](../../../learn/fundamentals/transactions/signatures-multisig.mdx) of Stellar accounts.
4343

4444
:::
4545

docs/learn/encyclopedia/security/securing-web-based-projects.mdx renamed to docs/build/security-docs/securing-web-based-projects.mdx

File renamed without changes.

docs/learn/encyclopedia/security/README.mdx

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/learn/fundamentals/contract-development/authorization.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ This is a special, built-in 'account contract' that handles all the Stellar acco
8787

8888
This supports the Stellar multisig with medium threshold. See Stellar [documentation] for more details on multisig and thresholds.
8989

90-
[documentation]: ../../encyclopedia/security/signatures-multisig.mdx
90+
[documentation]: ../transactions/signatures-multisig.mdx
9191

9292
##### Transaction Invoker
9393

docs/learn/fundamentals/stellar-data-structures/accounts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ There are two types of accounts on Stellar: Stellar accounts (`G...` addresses)
2828
- [Number of sponsored reserves](../../encyclopedia/transactions-specialized/sponsored-reserves.mdx)
2929
- [Number of subentries](./accounts.mdx#subentries)
3030
- [Sequence number](../../glossary.mdx#sequence-number)
31-
- [Signers](../../encyclopedia/security/signatures-multisig.mdx)
32-
- [Thresholds](../../encyclopedia/security/signatures-multisig.mdx#thresholds)
31+
- [Signers](../../fundamentals/transactions/signatures-multisig.mdx)
32+
- [Thresholds](../../fundamentals/transactions/signatures-multisig.mdx#thresholds)
3333

3434
## Base reserves and subentries
3535

docs/learn/fundamentals/transactions/list-of-operations.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ Set options for an account such as flags, inflation destination, signers, home d
249249

250250
Learn more about flags: [Flags Encyclopedia Entry](../../glossary.mdx#flags)
251251
Learn more about the home domain: [Stellar Ecosystem Proposals SEP-0001](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md)
252-
Learn more about signers operations and key weight: [Signature and Multisignature Encyclopedia Entry](../../encyclopedia/security/signatures-multisig.mdx)
252+
Learn more about signers operations and key weight: [Signature and Multisignature Encyclopedia Entry](../../fundamentals/transactions/signatures-multisig.mdx)
253253

254254
**SDKs**: [JavaScript](http://stellar.github.io/js-stellar-sdk/Operation.html#.setOptions) | [Java](https://github.com/lightsail-network/java-stellar-sdk/blob/master/src/main/java/org/stellar/sdk/operations/SetOptionsOperation.java) | [Go](https://godoc.org/github.com/stellar/go/txnbuild#SetOptions)
255255
**Threshold**: High (when updating signers or other thresholds) or Medium (when updating everything else)
@@ -262,9 +262,9 @@ Learn more about signers operations and key weight: [Signature and Multisignatur
262262
| Clear flags | integer | Indicates which [account](../stellar-data-structures/accounts.mdx) flags to clear. These account-level flags are primarily used by asset issuers. For details about the flags, please refer to the [Asset Design Considerations page](../../../tokens/control-asset-access.mdx). The bit mask integer subtracts from the existing flags of the account. This allows for setting specific bits without knowledge of existing flags. |
263263
| Set flags | integer | Indicates which [account](../stellar-data-structures/accounts.mdx) flags to set. These account-level flags are primarily used by asset issuers. For details about the flags, please refer to the [Asset Design Considerations page](../../../tokens/control-asset-access.mdx#controlling-access-to-an-asset-with-flags) The bit mask integer adds onto the existing flags of the account. This allows for setting specific bits without knowledge of existing flags. |
264264
| Master weight | integer | A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled. |
265-
| Low threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a low threshold](../../encyclopedia/security/signatures-multisig.mdx). |
266-
| Medium threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a medium threshold](../../encyclopedia/security/signatures-multisig.mdx). |
267-
| High threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a high threshold](../../encyclopedia/security/signatures-multisig.mdx). |
265+
| Low threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a low threshold](../../fundamentals/transactions/signatures-multisig.mdx). |
266+
| Medium threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a medium threshold](../../fundamentals/transactions/signatures-multisig.mdx). |
267+
| High threshold | integer | A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have [a high threshold](../../fundamentals/transactions/signatures-multisig.mdx). |
268268
| Home domain | string | Sets the home domain of an account. See [Federation](../../glossary.mdx#federation). |
269269
| Signer | \{Public Key, weight} | Add, update, or remove a signer from an account. Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0. |
270270

docs/learn/fundamentals/transactions/operations-and-transactions.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Operations are individual commands that modify the ledger. Operations are used t
1717

1818
All operations fall into one of three threshold categories: low, medium, or high, and each threshold category has a weight between 0 and 255 (which can be determined using set_options). Thresholds determine what signature weight is required for the operation to be accepted. For example, let’s say an account sets the medium threshold weight to 5. If the account wants to successfully establish a trustline with the `changeTrust` operation, the weight of the signature(s) must be greater than or equal to 5.
1919

20-
To learn more about signature weight, see the [Signature and Multisignature Encyclopedia Entry](../../encyclopedia/security/signatures-multisig.mdx).
20+
To learn more about signature weight, see the [Signature and Multisignature Encyclopedia Entry](../../fundamentals/transactions/signatures-multisig.mdx).
2121

2222
View a comprehensive list of Stellar operations and their threshold levels in the [List of Operations section](./list-of-operations.mdx).
2323

@@ -29,7 +29,7 @@ Accounts can only perform one transaction at a time.
2929

3030
Transactions comprise a bundle of between 1-100 operations (except smart contract transactions, which can only have one operation per transaction) and are signed and submitted to the ledger by accounts. Transactions always need to be authorized by the source account’s public key to be valid, which involves signing the transaction object with the public key’s associated secret key. A transaction plus its signature(s) is called a transaction envelope.
3131

32-
A transaction may need more than one signature- this happens if it has operations that affect more than one account or if it has a high threshold weight. Check out the [Signature and Multisignature Encyclopedia Entry](../../encyclopedia/security/signatures-multisig.mdx) for more information.
32+
A transaction may need more than one signature- this happens if it has operations that affect more than one account or if it has a high threshold weight. Check out the [Signature and Multisignature Encyclopedia Entry](../../fundamentals/transactions/signatures-multisig.mdx) for more information.
3333

3434
Transactions are atomic. Meaning if one operation in a transaction fails, all operations fail, and the entire transaction is not applied to the ledger.
3535

@@ -41,7 +41,7 @@ Smart contract transactions also go through a simulation process where developer
4141

4242
- [Fee](../fees-resource-limits-metering.mdx)
4343
- [List of operations](./list-of-operations.mdx)
44-
- [List of signatures](../../encyclopedia/security/signatures-multisig.mdx)
44+
- [List of signatures](../../fundamentals/transactions/signatures-multisig.mdx)
4545
- [Memo or muxed account](../../encyclopedia/transactions-specialized/pooled-accounts-muxed-accounts-memos.mdx)
4646
- [Sequence number](../../glossary.mdx#sequence-number)
4747
- [Source account](../../glossary.mdx#source-account)

docs/learn/encyclopedia/security/signatures-multisig.mdx renamed to docs/learn/fundamentals/transactions/signatures-multisig.mdx

File renamed without changes.

0 commit comments

Comments
 (0)