diff --git a/404.html b/404.html index a29e0b3..57bce8a 100644 --- a/404.html +++ b/404.html @@ -6,7 +6,7 @@ Page not found (404) • lockr - + @@ -18,7 +18,7 @@ - +
- +
@@ -88,16 +88,16 @@

Page not found (404)

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/CODE_OF_CONDUCT.html b/CODE_OF_CONDUCT.html index 790e5bf..32cb7b4 100644 --- a/CODE_OF_CONDUCT.html +++ b/CODE_OF_CONDUCT.html @@ -1,9 +1,9 @@ -Contributor Covenant Code of Conduct • lockrContributor Covenant Code of Conduct • lockr - +
- +
@@ -129,15 +129,15 @@

Attribution -

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index 9bfd7ac..4084d06 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -1,9 +1,9 @@ -Contributing to lockr • lockrContributing to lockr • lockr - +
- +
@@ -136,15 +136,15 @@

Development guidelines
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/LICENSE-text.html b/LICENSE-text.html index 2032208..53cad28 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,9 +1,9 @@ -License • lockrLicense • lockr - +
- +
@@ -65,15 +65,15 @@

License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/LICENSE.html b/LICENSE.html index 518ab8d..2cbdff3 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,9 +1,9 @@ -MIT License • lockrMIT License • lockr - +
- +
@@ -69,15 +69,15 @@

MIT License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/authors.html b/authors.html index 73deb75..cbdd3b5 100644 --- a/authors.html +++ b/authors.html @@ -1,9 +1,9 @@ -Authors and Citation • lockrAuthors and Citation • lockr - +
- +
-

Authors

+

Authors and Citation

- +
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/index.html b/index.html index e78e33b..8545327 100644 --- a/index.html +++ b/index.html @@ -6,21 +6,20 @@ Easily Encrypt/Decrypt Files • lockr - + - + - +
- +
@@ -188,16 +187,16 @@

Dev status

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/news/index.html b/news/index.html index 69dc501..8f0f3de 100644 --- a/news/index.html +++ b/news/index.html @@ -1,9 +1,9 @@ -Changelog • lockrChangelog • lockr - +
- +

Changelog

- Source: NEWS.md + Source: NEWS.md
@@ -81,15 +81,15 @@

lockr 0.

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/pkgdown.yml b/pkgdown.yml index fd70b9e..869d7b4 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,9 +1,8 @@ -pandoc: 2.19.2 -pkgdown: 2.0.7 +pandoc: 3.1.11 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: {} -last_built: 2023-09-26T04:52Z +last_built: 2024-08-12T08:26Z urls: reference: https://giperbio.github.io/lockr/reference article: https://giperbio.github.io/lockr/articles - diff --git a/reference/index.html b/reference/index.html index dc29106..a7dd78d 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,9 +1,9 @@ -Function reference • lockrPackage index • lockr - +
- +
@@ -79,15 +79,15 @@

Utilities -

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lock_dir.html b/reference/lock_dir.html index d300463..ffdfb3b 100644 --- a/reference/lock_dir.html +++ b/reference/lock_dir.html @@ -1,5 +1,5 @@ -Encrypt or decrypt all files in a directory — lock_dir • lockrEncrypt or decrypt all files in a directory — lock_dir • lockr - +
- +

Encrypt or decrypt all files in a directory

- Source: R/lock_dir.R + Source: R/lock_dir.R
@@ -79,37 +79,39 @@

Encrypt or decrypt all files in a directory

Arguments

-
dir
+ + +
dir

A string indicating the directory to encrypt/decrypt. (default: "./inst/extdata").

-
public_key
+
public_key

(optional) an openssl RSA public key or a string specifying the public key path. See rsa_keygen() to learn how to create an RSA key pair (default: "./inst/ssh/id_rsa.pub").

-
suffix
+
suffix

(optional) a string specifying the suffix to be added (when encrypting)/removed (when decrypting) to/of the file. It must start with . (default: ".lockr").

-
remove_file
+
remove_file

(optional) a logical value indicating if the original file must be removed after the encryption/decryption process (default: TRUE).

-
private_key
+
private_key

(optional) an openssl RSA private key or a string specifying the private key path. See rsa_keygen() to learn how to create an RSA key pair (default: "./inst/ssh/id_rsa").

-
password
+
password

(optional) only for protected keys. A string specifying the password to read the private key. Avoid typing passwords on the console, use askpass() instead (default: NULL).

@@ -117,14 +119,12 @@

Arguments

Value

- - -

An invisible NULL. These functions are called just for side +

An invisible NULL. These functions are called just for side effects.

See also

-

Other lock/unlock functions: +

Other lock/unlock functions: lock_file()

@@ -135,7 +135,7 @@

Examples

ssh_dir <- tempfile("ssh") dir.create(ssh_dir) rsa_keygen(ssh_dir) -#> Keys successfully created at '/tmp/Rtmp0la6Ed/ssh18f532ec4fcc'. +#> Keys successfully created at '/tmp/Rtmpz70sWH/ssh181463e8e3c0'. temp_dir <- tempfile("dir") dir.create(temp_dir) @@ -143,29 +143,28 @@

Examples

file.create(tempfile(tmpdir = temp_dir)) } list.files(temp_dir) -#> [1] "file18f5154ecd48" "file18f5305ba305" "file18f563237587" "file18f56886b715" -#> [5] "file18f568bd901e" +#> [1] "file181413a056f8" "file1814239e1c8" "file181454f7c22f" "file18145843c12d" +#> [5] "file18146a6098c2" lock_dir(temp_dir, public_key = file.path(ssh_dir, "id_rsa.pub")) #> Locked file written at -#> '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f5154ecd48.lockr'. -#> Locked file written at -#> '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f5305ba305.lockr'. +#> '/tmp/Rtmpz70sWH/dir181434dba423/file181413a056f8.lockr'. +#> Locked file written at '/tmp/Rtmpz70sWH/dir181434dba423/file1814239e1c8.lockr'. #> Locked file written at -#> '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f563237587.lockr'. +#> '/tmp/Rtmpz70sWH/dir181434dba423/file181454f7c22f.lockr'. #> Locked file written at -#> '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f56886b715.lockr'. +#> '/tmp/Rtmpz70sWH/dir181434dba423/file18145843c12d.lockr'. #> Locked file written at -#> '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f568bd901e.lockr'. +#> '/tmp/Rtmpz70sWH/dir181434dba423/file18146a6098c2.lockr'. ## Unlocking files unlock_dir(temp_dir, private_key = file.path(ssh_dir, "id_rsa")) -#> Unlocked file written at '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f5154ecd48'. -#> Unlocked file written at '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f5305ba305'. -#> Unlocked file written at '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f563237587'. -#> Unlocked file written at '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f56886b715'. -#> Unlocked file written at '/tmp/Rtmp0la6Ed/dir18f5460642e0/file18f568bd901e'. +#> Unlocked file written at '/tmp/Rtmpz70sWH/dir181434dba423/file181413a056f8'. +#> Unlocked file written at '/tmp/Rtmpz70sWH/dir181434dba423/file1814239e1c8'. +#> Unlocked file written at '/tmp/Rtmpz70sWH/dir181434dba423/file181454f7c22f'. +#> Unlocked file written at '/tmp/Rtmpz70sWH/dir181434dba423/file18145843c12d'. +#> Unlocked file written at '/tmp/Rtmpz70sWH/dir181434dba423/file18146a6098c2'.
@@ -180,15 +179,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lock_file.html b/reference/lock_file.html index cfce2a1..08f213c 100644 --- a/reference/lock_file.html +++ b/reference/lock_file.html @@ -1,5 +1,5 @@ -Encrypt or decrypt single files — lock_file • lockrEncrypt or decrypt single files — lock_file • lockr - +
- +

Encrypt or decrypt single files

- Source: R/lock_file.R + Source: R/lock_file.R
@@ -87,37 +87,39 @@

Encrypt or decrypt single files

Arguments

-
file
+ + +
file

A string with the file path to be encrypted/decrypted. For security reasons, encrypted files must end with the suffix parameter.

-
public_key
+
public_key

(optional) an openssl RSA public key or a string specifying the public key path. See rsa_keygen() to learn how to create an RSA key pair (default: "./inst/ssh/id_rsa.pub").

-
suffix
+
suffix

(optional) a string specifying the suffix to be added (when encrypting)/removed (when decrypting) to/of the file. It must start with . (default: ".lockr").

-
remove_file
+
remove_file

(optional) a logical value indicating if the original file must be removed after the encryption/decryption process (default: TRUE).

-
private_key
+
private_key

(optional) an openssl RSA private key or a string specifying the private key path. See rsa_keygen() to learn how to create an RSA key pair (default: "./inst/ssh/id_rsa").

-
password
+
password

(optional) only for protected keys. A string specifying the password to read the private key. Avoid typing passwords on the console, use askpass() instead (default: NULL).

@@ -125,13 +127,11 @@

Arguments

Value

- - -

An invisible string containing the locked/unlocked file path.

+

An invisible string containing the locked/unlocked file path.

See also

-

Other lock/unlock functions: +

Other lock/unlock functions: lock_dir()

@@ -143,37 +143,39 @@

Examples

dir.create(temp_dir) temp_file <- tempfile(tmpdir = temp_dir) rsa_keygen(temp_dir) -#> Keys successfully created at '/tmp/Rtmp0la6Ed/dir18f529924015'. +#> Keys successfully created at '/tmp/Rtmpz70sWH/dir18142c1b450f'. con <- file(temp_file, "w+") cat("Test", file = temp_file, sep = "\n") list.files(temp_dir) -#> [1] "file18f54e1cab29" "id_rsa" "id_rsa.pub" +#> [1] "file1814132ef01f" "id_rsa" "id_rsa.pub" suppressWarnings(readLines(con)) #> [1] "Test" close(con) lock_file(temp_file, public_key = file.path(temp_dir, "id_rsa.pub")) #> Locked file written at -#> '/tmp/Rtmp0la6Ed/dir18f529924015/file18f54e1cab29.lockr'. +#> '/tmp/Rtmpz70sWH/dir18142c1b450f/file1814132ef01f.lockr'. temp_file_locked <- paste0(temp_file, ".lockr") con <- file(temp_file_locked, "rb") list.files(temp_dir) -#> [1] "file18f54e1cab29.lockr" "id_rsa" "id_rsa.pub" +#> [1] "file1814132ef01f.lockr" "id_rsa" "id_rsa.pub" suppressWarnings(readLines(con)) -#> [1] "\037\x8b\b" -#> [2] "\xfb\x8c\xa0\x9b[\0265\035\x88\x9f\xff\xdbu\xcdʈv\xbf\xebZ9\xc7;l6\xdf\\\037{\xf0\x9d\xec\x8dIV\x9f\xef>eΰ̊\x90\xfd\xe1Rr>\xce\xcc\xe6ͻ&\xc1\x9d%z\xe2k\xb8.|\xccU\xfb\xa4\x91u\x89y\xe5\xb7e\177\xfelz\xc3\xf8\x80\xeb\xe8L\x95:\xb6;\035\xf6\xd3;XO\x9d\xbb\xbe.ro\x90N\xf5\xfcE\0238\xb4\xbaD\x94Z_+\x9aE\xac({t\xab\x83\xf3ҡ\xf2]\x9aO\xdbڬj\xee\x88\037|\xbfWr\xe1\x9e,\xfdEo\xf6\x96o{\xb2\xbaqw\xee\xd64\xad\025\xba\035>߯3~X\xf2X\xe1\xe3?\x99Y/\xed\xe1\xe1\xb3]-!\xbd\xf9s;_\xa9\xfc\037\xa1\017?M\030\030X\x98\030@\001\xc4\xc2\xc0\t" -#> [3] "Լ\xc4\xdc\xd4b\x90BHh\x83\005\x992ˠ,\xf6\xe2\xd4\xe2\xe2\xcc\xfc<(\x97%%\xb1$\021H\xff\003" +#> [1] "\037\x8b\b" +#> [2] "g\025V<\xdd\t\021gdXٻu\xf2\x8e\xcc\vS\xae=\xf62_|y\x96\xde\xff\x86\v\xf6\xe7\xc2r\xb7r2\xce\xd1Ꞷ\xe2\xc4\006\xf7\x90\x83\xf3\xf6Ζ}\xf3o\x99\xa2P\xd8\xd2s\xb1j\xbb\xbd\024\xe4s\xb7\xcav~w\xf8hb+\xd86\xaf\xf3\xbbK\xaa\xf3>\x9e5\fq" +#> [3] "\x8e\x8f8=Uט\xf7\xa5\xab/qH\x9a\xef7\x9b\xab\xeb\022\x8f\xc5\xcd7\036\022\xc7\027\xbf\017\xfa:_\xfb\x98\xc9)\x85\x88" +#> [4] "!\xa1" +#> [5] "\026d\xca,\x83\xb2؋S\x8b\x8b3\xf3\xf3\xa0\\\x96\x94ĒD \xfd\017" close(con) ## Unlocking files unlock_file(temp_file_locked, private_key = file.path(temp_dir, "id_rsa")) -#> Unlocked file written at '/tmp/Rtmp0la6Ed/dir18f529924015/file18f54e1cab29'. +#> Unlocked file written at '/tmp/Rtmpz70sWH/dir18142c1b450f/file1814132ef01f'. list.files(temp_dir) -#> [1] "file18f54e1cab29" "id_rsa" "id_rsa.pub" +#> [1] "file1814132ef01f" "id_rsa" "id_rsa.pub" con <- file(temp_file, "r+") readLines(con) #> [1] "Test" @@ -192,15 +194,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lockr-package.html b/reference/lockr-package.html index 6e3fae0..904d019 100644 --- a/reference/lockr-package.html +++ b/reference/lockr-package.html @@ -1,9 +1,9 @@ -lockr: Easily Encrypt/Decrypt Files — lockr-package • lockrlockr: Easily Encrypt/Decrypt Files — lockr-package • lockr - +
- +

lockr: Easily Encrypt/Decrypt Files

- Source: R/lockr-package.R + Source: R/lockr-package.R
@@ -77,15 +77,15 @@

Author

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lockr.html b/reference/lockr.html new file mode 100644 index 0000000..f895660 --- /dev/null +++ b/reference/lockr.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/rsa_keygen.html b/reference/rsa_keygen.html index ecebb8d..378132a 100644 --- a/reference/rsa_keygen.html +++ b/reference/rsa_keygen.html @@ -1,10 +1,10 @@ -Generate and write a pair of RSA keys — rsa_keygen • lockrGenerate and write a pair of RSA keys — rsa_keygen • lockr - +
- +

Generate and write a pair of RSA keys

- Source: R/rsa_keygen.R + Source: R/rsa_keygen.R
@@ -60,27 +60,27 @@

Generate and write a pair of RSA keys

Arguments

-
dir
+ + +
dir

(optional) a string specifying the directory to save the generated keys (default: "./inst/ssh")

-
password
+
password

(optional) a string specifying the password to protect the private key. If NULL, the private key will not be protected (default: NULL).

-
bits
+
bits

(optional) an integer number specifying the length of the RSA key in bits (default: 2048).

Value

- - -

An invisible NULL. This function is called for side effects only.

+

An invisible NULL. This function is called for side effects only.

@@ -89,7 +89,7 @@

Examples

dir.create(temp_dir) rsa_keygen(dir = temp_dir, password = "test", bits = 2048) -#> Keys successfully created at '/tmp/Rtmp0la6Ed/dir18f548f62ffe'. +#> Keys successfully created at '/tmp/Rtmpz70sWH/dir1814242357d1'. list.files(temp_dir) #> [1] "id_rsa" "id_rsa.pub" @@ -107,15 +107,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/unlock_dir.html b/reference/unlock_dir.html new file mode 100644 index 0000000..bf686f2 --- /dev/null +++ b/reference/unlock_dir.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/reference/unlock_file.html b/reference/unlock_file.html new file mode 100644 index 0000000..9e7f4c6 --- /dev/null +++ b/reference/unlock_file.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/sitemap.xml b/sitemap.xml index b06c5ab..311555e 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,42 +1,16 @@ - - - - https://giperbio.github.io/lockr/404.html - - - https://giperbio.github.io/lockr/CODE_OF_CONDUCT.html - - - https://giperbio.github.io/lockr/CONTRIBUTING.html - - - https://giperbio.github.io/lockr/LICENSE-text.html - - - https://giperbio.github.io/lockr/LICENSE.html - - - https://giperbio.github.io/lockr/authors.html - - - https://giperbio.github.io/lockr/index.html - - - https://giperbio.github.io/lockr/news/index.html - - - https://giperbio.github.io/lockr/reference/index.html - - - https://giperbio.github.io/lockr/reference/lock_dir.html - - - https://giperbio.github.io/lockr/reference/lock_file.html - - - https://giperbio.github.io/lockr/reference/lockr-package.html - - - https://giperbio.github.io/lockr/reference/rsa_keygen.html - + +https://giperbio.github.io/lockr/404.html +https://giperbio.github.io/lockr/CODE_OF_CONDUCT.html +https://giperbio.github.io/lockr/CONTRIBUTING.html +https://giperbio.github.io/lockr/LICENSE-text.html +https://giperbio.github.io/lockr/LICENSE.html +https://giperbio.github.io/lockr/authors.html +https://giperbio.github.io/lockr/index.html +https://giperbio.github.io/lockr/news/index.html +https://giperbio.github.io/lockr/reference/index.html +https://giperbio.github.io/lockr/reference/lock_dir.html +https://giperbio.github.io/lockr/reference/lock_file.html +https://giperbio.github.io/lockr/reference/lockr-package.html +https://giperbio.github.io/lockr/reference/rsa_keygen.html +